| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <html lang="en"> |
| <head> |
| <title>Source code</title> |
| <link rel="stylesheet" type="text/css" href="../../../../../../javadoc.css" title="Style"> |
| </head> |
| <body> |
| <div class="sourceContainer"> |
| <pre><span class="sourceLineNo">001</span>// ***************************************************************************************************************************<a name="line.1"></a> |
| <span class="sourceLineNo">002</span>// * Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file *<a name="line.2"></a> |
| <span class="sourceLineNo">003</span>// * distributed with this work for additional information regarding copyright ownership. The ASF licenses this file *<a name="line.3"></a> |
| <span class="sourceLineNo">004</span>// * to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance *<a name="line.4"></a> |
| <span class="sourceLineNo">005</span>// * with the License. You may obtain a copy of the License at *<a name="line.5"></a> |
| <span class="sourceLineNo">006</span>// * *<a name="line.6"></a> |
| <span class="sourceLineNo">007</span>// * http://www.apache.org/licenses/LICENSE-2.0 *<a name="line.7"></a> |
| <span class="sourceLineNo">008</span>// * *<a name="line.8"></a> |
| <span class="sourceLineNo">009</span>// * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an *<a name="line.9"></a> |
| <span class="sourceLineNo">010</span>// * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the *<a name="line.10"></a> |
| <span class="sourceLineNo">011</span>// * specific language governing permissions and limitations under the License. *<a name="line.11"></a> |
| <span class="sourceLineNo">012</span>// ***************************************************************************************************************************<a name="line.12"></a> |
| <span class="sourceLineNo">013</span>package org.apache.juneau.http.annotation;<a name="line.13"></a> |
| <span class="sourceLineNo">014</span><a name="line.14"></a> |
| <span class="sourceLineNo">015</span>import static java.lang.annotation.ElementType.*;<a name="line.15"></a> |
| <span class="sourceLineNo">016</span>import static java.lang.annotation.RetentionPolicy.*;<a name="line.16"></a> |
| <span class="sourceLineNo">017</span><a name="line.17"></a> |
| <span class="sourceLineNo">018</span>import java.lang.annotation.*;<a name="line.18"></a> |
| <span class="sourceLineNo">019</span><a name="line.19"></a> |
| <span class="sourceLineNo">020</span>import org.apache.juneau.jsonschema.annotation.Schema;<a name="line.20"></a> |
| <span class="sourceLineNo">021</span>import org.apache.juneau.*;<a name="line.21"></a> |
| <span class="sourceLineNo">022</span>import org.apache.juneau.annotation.*;<a name="line.22"></a> |
| <span class="sourceLineNo">023</span>import org.apache.juneau.httppart.*;<a name="line.23"></a> |
| <span class="sourceLineNo">024</span>import org.apache.juneau.json.*;<a name="line.24"></a> |
| <span class="sourceLineNo">025</span>import org.apache.juneau.jsonschema.*;<a name="line.25"></a> |
| <span class="sourceLineNo">026</span>import org.apache.juneau.oapi.*;<a name="line.26"></a> |
| <span class="sourceLineNo">027</span><a name="line.27"></a> |
| <span class="sourceLineNo">028</span>/**<a name="line.28"></a> |
| <span class="sourceLineNo">029</span> * REST response annotation.<a name="line.29"></a> |
| <span class="sourceLineNo">030</span> *<a name="line.30"></a> |
| <span class="sourceLineNo">031</span> * <p><a name="line.31"></a> |
| <span class="sourceLineNo">032</span> * Identifies an interface to use to interact with HTTP parts of an HTTP response through a bean.<a name="line.32"></a> |
| <span class="sourceLineNo">033</span> *<a name="line.33"></a> |
| <span class="sourceLineNo">034</span> * <p><a name="line.34"></a> |
| <span class="sourceLineNo">035</span> * Can be used in the following locations:<a name="line.35"></a> |
| <span class="sourceLineNo">036</span> * <ul><a name="line.36"></a> |
| <span class="sourceLineNo">037</span> * <li>Exception classes thrown from server-side <ja>@RestMethod</ja>-annotated methods.<a name="line.37"></a> |
| <span class="sourceLineNo">038</span> * <li>Return type classes of server-side <ja>@RestMethod</ja>-annotated methods.<a name="line.38"></a> |
| <span class="sourceLineNo">039</span> * <li>Arguments and argument-types of server-side <ja>@RestMethod</ja>-annotated methods.<a name="line.39"></a> |
| <span class="sourceLineNo">040</span> * <li>Return type classes of server-side <ja>@RemoteMethod</ja>-annotated methods.<a name="line.40"></a> |
| <span class="sourceLineNo">041</span> * <li>Client-side <ja>@RemoteMethod</ja>-annotated methods.<a name="line.41"></a> |
| <span class="sourceLineNo">042</span> * <li>Return type interfaces of client-side <ja>@RemoteMethod</ja>-annotated methods.<a name="line.42"></a> |
| <span class="sourceLineNo">043</span> * </ul><a name="line.43"></a> |
| <span class="sourceLineNo">044</span> *<a name="line.44"></a> |
| <span class="sourceLineNo">045</span> * <ul class='seealso'><a name="line.45"></a> |
| <span class="sourceLineNo">046</span> * <li class='link'>{@doc juneau-rest-server.HttpPartAnnotations.Response}<a name="line.46"></a> |
| <span class="sourceLineNo">047</span> * <li class='link'>{@doc juneau-rest-client.RestProxies.Response}<a name="line.47"></a> |
| <span class="sourceLineNo">048</span> * <li class='link'>{@doc juneau-rest-server.Swagger}<a name="line.48"></a> |
| <span class="sourceLineNo">049</span> * <li class='extlink'>{@doc SwaggerResponseObject}<a name="line.49"></a> |
| <span class="sourceLineNo">050</span> * </ul><a name="line.50"></a> |
| <span class="sourceLineNo">051</span> */<a name="line.51"></a> |
| <span class="sourceLineNo">052</span>@Documented<a name="line.52"></a> |
| <span class="sourceLineNo">053</span>@Target({PARAMETER,TYPE,METHOD})<a name="line.53"></a> |
| <span class="sourceLineNo">054</span>@Retention(RUNTIME)<a name="line.54"></a> |
| <span class="sourceLineNo">055</span>@Inherited<a name="line.55"></a> |
| <span class="sourceLineNo">056</span>public @interface Response {<a name="line.56"></a> |
| <span class="sourceLineNo">057</span><a name="line.57"></a> |
| <span class="sourceLineNo">058</span> /**<a name="line.58"></a> |
| <span class="sourceLineNo">059</span> * Specifies the {@link HttpPartParser} class used for parsing strings to values.<a name="line.59"></a> |
| <span class="sourceLineNo">060</span> *<a name="line.60"></a> |
| <span class="sourceLineNo">061</span> * <p><a name="line.61"></a> |
| <span class="sourceLineNo">062</span> * Overrides for this part the part parser defined on the REST resource which by default is {@link OpenApiParser}.<a name="line.62"></a> |
| <span class="sourceLineNo">063</span> */<a name="line.63"></a> |
| <span class="sourceLineNo">064</span> Class<? extends HttpPartParser> partParser() default HttpPartParser.Null.class;<a name="line.64"></a> |
| <span class="sourceLineNo">065</span><a name="line.65"></a> |
| <span class="sourceLineNo">066</span> /**<a name="line.66"></a> |
| <span class="sourceLineNo">067</span> * Specifies the {@link HttpPartSerializer} class used for serializing values to strings.<a name="line.67"></a> |
| <span class="sourceLineNo">068</span> *<a name="line.68"></a> |
| <span class="sourceLineNo">069</span> * <p><a name="line.69"></a> |
| <span class="sourceLineNo">070</span> * Overrides for this part the part serializer defined on the REST resource which by default is {@link OpenApiSerializer}.<a name="line.70"></a> |
| <span class="sourceLineNo">071</span> */<a name="line.71"></a> |
| <span class="sourceLineNo">072</span> Class<? extends HttpPartSerializer> partSerializer() default HttpPartSerializer.Null.class;<a name="line.72"></a> |
| <span class="sourceLineNo">073</span><a name="line.73"></a> |
| <span class="sourceLineNo">074</span> /**<a name="line.74"></a> |
| <span class="sourceLineNo">075</span> * The HTTP response code.<a name="line.75"></a> |
| <span class="sourceLineNo">076</span> *<a name="line.76"></a> |
| <span class="sourceLineNo">077</span> * The default value is <c>500</c> for exceptions and <c>200</c> for return types.<a name="line.77"></a> |
| <span class="sourceLineNo">078</span> */<a name="line.78"></a> |
| <span class="sourceLineNo">079</span> int[] code() default {};<a name="line.79"></a> |
| <span class="sourceLineNo">080</span><a name="line.80"></a> |
| <span class="sourceLineNo">081</span> /**<a name="line.81"></a> |
| <span class="sourceLineNo">082</span> * A synonym for {@link #code()}.<a name="line.82"></a> |
| <span class="sourceLineNo">083</span> *<a name="line.83"></a> |
| <span class="sourceLineNo">084</span> * <p><a name="line.84"></a> |
| <span class="sourceLineNo">085</span> * Allows you to use shortened notation if you're only specifying the code.<a name="line.85"></a> |
| <span class="sourceLineNo">086</span> *<a name="line.86"></a> |
| <span class="sourceLineNo">087</span> * <p><a name="line.87"></a> |
| <span class="sourceLineNo">088</span> * The following are completely equivalent ways of defining the response code:<a name="line.88"></a> |
| <span class="sourceLineNo">089</span> * <p class='bcode w800'><a name="line.89"></a> |
| <span class="sourceLineNo">090</span> * <ja>@Response</ja>(code=404)<a name="line.90"></a> |
| <span class="sourceLineNo">091</span> * <jk>public class</jk> NotFound <jk>extends</jk> RestException {...}<a name="line.91"></a> |
| <span class="sourceLineNo">092</span> * </p><a name="line.92"></a> |
| <span class="sourceLineNo">093</span> * <p class='bcode w800'><a name="line.93"></a> |
| <span class="sourceLineNo">094</span> * <ja>@Response</ja>(404)<a name="line.94"></a> |
| <span class="sourceLineNo">095</span> * <jk>public class</jk> NotFound <jk>extends</jk> RestException {...}<a name="line.95"></a> |
| <span class="sourceLineNo">096</span> * </p><a name="line.96"></a> |
| <span class="sourceLineNo">097</span> */<a name="line.97"></a> |
| <span class="sourceLineNo">098</span> int[] value() default {};<a name="line.98"></a> |
| <span class="sourceLineNo">099</span><a name="line.99"></a> |
| <span class="sourceLineNo">100</span> /**<a name="line.100"></a> |
| <span class="sourceLineNo">101</span> * <mk>description</mk> field of the {@doc SwaggerResponseObject}.<a name="line.101"></a> |
| <span class="sourceLineNo">102</span> *<a name="line.102"></a> |
| <span class="sourceLineNo">103</span> * <h5 class='section'>Used for:</h5><a name="line.103"></a> |
| <span class="sourceLineNo">104</span> * <ul class='spaced-list'><a name="line.104"></a> |
| <span class="sourceLineNo">105</span> * <li><a name="line.105"></a> |
| <span class="sourceLineNo">106</span> * Server-side generated Swagger documentation.<a name="line.106"></a> |
| <span class="sourceLineNo">107</span> * </ul><a name="line.107"></a> |
| <span class="sourceLineNo">108</span> *<a name="line.108"></a> |
| <span class="sourceLineNo">109</span> * <ul class='notes'><a name="line.109"></a> |
| <span class="sourceLineNo">110</span> * <li><a name="line.110"></a> |
| <span class="sourceLineNo">111</span> * The format is plain text.<a name="line.111"></a> |
| <span class="sourceLineNo">112</span> * <br>Multiple lines are concatenated with newlines.<a name="line.112"></a> |
| <span class="sourceLineNo">113</span> * <li><a name="line.113"></a> |
| <span class="sourceLineNo">114</span> * Supports {@doc DefaultRestSvlVariables}<a name="line.114"></a> |
| <span class="sourceLineNo">115</span> * (e.g. <js>"$L{my.localized.variable}"</js>).<a name="line.115"></a> |
| <span class="sourceLineNo">116</span> * </ul><a name="line.116"></a> |
| <span class="sourceLineNo">117</span> */<a name="line.117"></a> |
| <span class="sourceLineNo">118</span> String[] description() default {};<a name="line.118"></a> |
| <span class="sourceLineNo">119</span><a name="line.119"></a> |
| <span class="sourceLineNo">120</span> /**<a name="line.120"></a> |
| <span class="sourceLineNo">121</span> * <mk>schema</mk> field of the {@doc SwaggerResponseObject}.<a name="line.121"></a> |
| <span class="sourceLineNo">122</span> *<a name="line.122"></a> |
| <span class="sourceLineNo">123</span> * <h5 class='section'>Used for:</h5><a name="line.123"></a> |
| <span class="sourceLineNo">124</span> * <ul class='spaced-list'><a name="line.124"></a> |
| <span class="sourceLineNo">125</span> * <li><a name="line.125"></a> |
| <span class="sourceLineNo">126</span> * Server-side schema-based serializing and serializing validation.<a name="line.126"></a> |
| <span class="sourceLineNo">127</span> * <li><a name="line.127"></a> |
| <span class="sourceLineNo">128</span> * Server-side generated Swagger documentation.<a name="line.128"></a> |
| <span class="sourceLineNo">129</span> * </ul><a name="line.129"></a> |
| <span class="sourceLineNo">130</span> */<a name="line.130"></a> |
| <span class="sourceLineNo">131</span> Schema schema() default @Schema;<a name="line.131"></a> |
| <span class="sourceLineNo">132</span><a name="line.132"></a> |
| <span class="sourceLineNo">133</span> /**<a name="line.133"></a> |
| <span class="sourceLineNo">134</span> * <mk>headers</mk> field of the {@doc SwaggerResponseObject}.<a name="line.134"></a> |
| <span class="sourceLineNo">135</span> *<a name="line.135"></a> |
| <span class="sourceLineNo">136</span> * <h5 class='section'>Used for:</h5><a name="line.136"></a> |
| <span class="sourceLineNo">137</span> * <ul class='spaced-list'><a name="line.137"></a> |
| <span class="sourceLineNo">138</span> * <li><a name="line.138"></a> |
| <span class="sourceLineNo">139</span> * Server-side generated Swagger documentation.<a name="line.139"></a> |
| <span class="sourceLineNo">140</span> * </ul><a name="line.140"></a> |
| <span class="sourceLineNo">141</span> */<a name="line.141"></a> |
| <span class="sourceLineNo">142</span> ResponseHeader[] headers() default {};<a name="line.142"></a> |
| <span class="sourceLineNo">143</span><a name="line.143"></a> |
| <span class="sourceLineNo">144</span> /**<a name="line.144"></a> |
| <span class="sourceLineNo">145</span> * A serialized example of the body of a response.<a name="line.145"></a> |
| <span class="sourceLineNo">146</span> *<a name="line.146"></a> |
| <span class="sourceLineNo">147</span> * <p><a name="line.147"></a> |
| <span class="sourceLineNo">148</span> * This is the {@doc SimpleJson} of an example of the body.<a name="line.148"></a> |
| <span class="sourceLineNo">149</span> *<a name="line.149"></a> |
| <span class="sourceLineNo">150</span> * <p><a name="line.150"></a> |
| <span class="sourceLineNo">151</span> * This value is converted to a POJO and then serialized to all the registered serializers on the REST method to produce examples for all<a name="line.151"></a> |
| <span class="sourceLineNo">152</span> * supported language types.<a name="line.152"></a> |
| <span class="sourceLineNo">153</span> * <br>These values are then used to automatically populate the {@link #examples} field.<a name="line.153"></a> |
| <span class="sourceLineNo">154</span> *<a name="line.154"></a> |
| <span class="sourceLineNo">155</span> * <h5 class='section'>Example:</h5><a name="line.155"></a> |
| <span class="sourceLineNo">156</span> * <p class='bcode w800'><a name="line.156"></a> |
| <span class="sourceLineNo">157</span> * <jc>// A JSON representation of a PetCreate object.</jc><a name="line.157"></a> |
| <span class="sourceLineNo">158</span> * <ja>@Response</ja>(<a name="line.158"></a> |
| <span class="sourceLineNo">159</span> * example=<js>"{name:'Doggie',price:9.99,species:'Dog',tags:['friendly','cute']}"</js><a name="line.159"></a> |
| <span class="sourceLineNo">160</span> * )<a name="line.160"></a> |
| <span class="sourceLineNo">161</span> * </p><a name="line.161"></a> |
| <span class="sourceLineNo">162</span> *<a name="line.162"></a> |
| <span class="sourceLineNo">163</span> * <p><a name="line.163"></a> |
| <span class="sourceLineNo">164</span> * There are several other options for defining this example:<a name="line.164"></a> |
| <span class="sourceLineNo">165</span> * <ul class='spaced-list'><a name="line.165"></a> |
| <span class="sourceLineNo">166</span> * <li><a name="line.166"></a> |
| <span class="sourceLineNo">167</span> * Defining an <js>"x-example"</js> field in the inherited Swagger JSON response object (classpath file or <code><ja>@ResourceSwagger</ja>(value)</code>/<code><ja>@MethodSwagger</ja>(value)</code>).<a name="line.167"></a> |
| <span class="sourceLineNo">168</span> * <li><a name="line.168"></a> |
| <span class="sourceLineNo">169</span> * Defining an <js>"x-example"</js> field in the Swagger Schema Object for the response object (including referenced <js>"$ref"</js> schemas).<a name="line.169"></a> |
| <span class="sourceLineNo">170</span> * <li><a name="line.170"></a> |
| <span class="sourceLineNo">171</span> * Allowing Juneau to auto-generate a code example.<a name="line.171"></a> |
| <span class="sourceLineNo">172</span> * </ul><a name="line.172"></a> |
| <span class="sourceLineNo">173</span> *<a name="line.173"></a> |
| <span class="sourceLineNo">174</span> * <p><a name="line.174"></a> |
| <span class="sourceLineNo">175</span> * The latter is important because Juneau also supports auto-generation of JSON-Schema from POJO classes using {@link JsonSchemaSerializer} which has several of it's own<a name="line.175"></a> |
| <span class="sourceLineNo">176</span> * options for auto-detecting and calculation POJO examples.<a name="line.176"></a> |
| <span class="sourceLineNo">177</span> *<a name="line.177"></a> |
| <span class="sourceLineNo">178</span> * <p><a name="line.178"></a> |
| <span class="sourceLineNo">179</span> * In particular, examples can be defined via static methods, fields, and annotations on the classes themselves.<a name="line.179"></a> |
| <span class="sourceLineNo">180</span> *<a name="line.180"></a> |
| <span class="sourceLineNo">181</span> * <p class='bcode w800'><a name="line.181"></a> |
| <span class="sourceLineNo">182</span> * <jc>// Annotation on class.</jc><a name="line.182"></a> |
| <span class="sourceLineNo">183</span> * <ja>@Example</ja>(<js>"{name:'Doggie',price:9.99,species:'Dog',tags:['friendly','cute']}"</js>)<a name="line.183"></a> |
| <span class="sourceLineNo">184</span> * <jk>public class</jk> PetCreate {<a name="line.184"></a> |
| <span class="sourceLineNo">185</span> * ...<a name="line.185"></a> |
| <span class="sourceLineNo">186</span> * }<a name="line.186"></a> |
| <span class="sourceLineNo">187</span> * </p><a name="line.187"></a> |
| <span class="sourceLineNo">188</span> * <p class='bcode w800'><a name="line.188"></a> |
| <span class="sourceLineNo">189</span> * <jc>// Annotation on static method.</jc><a name="line.189"></a> |
| <span class="sourceLineNo">190</span> * <jk>public class</jk> PetCreate {<a name="line.190"></a> |
| <span class="sourceLineNo">191</span> *<a name="line.191"></a> |
| <span class="sourceLineNo">192</span> * <ja>@Example</ja><a name="line.192"></a> |
| <span class="sourceLineNo">193</span> * <jk>public static</jk> PetCreate <jsm>sample</jsm>() {<a name="line.193"></a> |
| <span class="sourceLineNo">194</span> * <jk>return new</jk> PetCreate(<js>"Doggie"</js>, 9.99f, <js>"Dog"</js>, <jk>new</jk> String[] {<js>"friendly"</js>,<js>"cute"</js>});<a name="line.194"></a> |
| <span class="sourceLineNo">195</span> * }<a name="line.195"></a> |
| <span class="sourceLineNo">196</span> * }<a name="line.196"></a> |
| <span class="sourceLineNo">197</span> * </p><a name="line.197"></a> |
| <span class="sourceLineNo">198</span> * <p class='bcode w800'><a name="line.198"></a> |
| <span class="sourceLineNo">199</span> * <jc>// Static method with specific name 'example'.</jc><a name="line.199"></a> |
| <span class="sourceLineNo">200</span> * <jk>public class</jk> PetCreate {<a name="line.200"></a> |
| <span class="sourceLineNo">201</span> *<a name="line.201"></a> |
| <span class="sourceLineNo">202</span> * <jk>public static</jk> PetCreate <jsm>example</jsm>() {<a name="line.202"></a> |
| <span class="sourceLineNo">203</span> * <jk>return new</jk> PetCreate(<js>"Doggie"</js>, 9.99f, <js>"Dog"</js>, <jk>new</jk> String[] {<js>"friendly"</js>,<js>"cute"</js>});<a name="line.203"></a> |
| <span class="sourceLineNo">204</span> * }<a name="line.204"></a> |
| <span class="sourceLineNo">205</span> * }<a name="line.205"></a> |
| <span class="sourceLineNo">206</span> * </p><a name="line.206"></a> |
| <span class="sourceLineNo">207</span> * <p class='bcode w800'><a name="line.207"></a> |
| <span class="sourceLineNo">208</span> * <jc>// Static field.</jc><a name="line.208"></a> |
| <span class="sourceLineNo">209</span> * <jk>public class</jk> PetCreate {<a name="line.209"></a> |
| <span class="sourceLineNo">210</span> *<a name="line.210"></a> |
| <span class="sourceLineNo">211</span> * <ja>@Example</ja><a name="line.211"></a> |
| <span class="sourceLineNo">212</span> * <jk>public static</jk> PetCreate <jsf>EXAMPLE</jsf> = <jk>new</jk> PetCreate(<js>"Doggie"</js>, 9.99f, <js>"Dog"</js>, <jk>new</jk> String[] {<js>"friendly"</js>,<js>"cute"</js>});<a name="line.212"></a> |
| <span class="sourceLineNo">213</span> * }<a name="line.213"></a> |
| <span class="sourceLineNo">214</span> * </p><a name="line.214"></a> |
| <span class="sourceLineNo">215</span> *<a name="line.215"></a> |
| <span class="sourceLineNo">216</span> * <p><a name="line.216"></a> |
| <span class="sourceLineNo">217</span> * Examples can also be specified via generic properties as well using the {@link BeanContext#BEAN_examples} property at either the class or method level.<a name="line.217"></a> |
| <span class="sourceLineNo">218</span> * <p class='bcode w800'><a name="line.218"></a> |
| <span class="sourceLineNo">219</span> * <jc>// Examples defined at class level.</jc><a name="line.219"></a> |
| <span class="sourceLineNo">220</span> * <ja>@Rest</ja>(<a name="line.220"></a> |
| <span class="sourceLineNo">221</span> * properties={<a name="line.221"></a> |
| <span class="sourceLineNo">222</span> * <ja>@Property</ja>(<a name="line.222"></a> |
| <span class="sourceLineNo">223</span> * name=<jsf>BEAN_examples</jsf>,<a name="line.223"></a> |
| <span class="sourceLineNo">224</span> * value=<js>"{'org.apache.juneau.examples.rest.petstore.PetCreate': {name:'Doggie',price:9.99,species:'Dog',tags:['friendly','cute']}}"</js><a name="line.224"></a> |
| <span class="sourceLineNo">225</span> * )<a name="line.225"></a> |
| <span class="sourceLineNo">226</span> * }<a name="line.226"></a> |
| <span class="sourceLineNo">227</span> * )<a name="line.227"></a> |
| <span class="sourceLineNo">228</span> * </p><a name="line.228"></a> |
| <span class="sourceLineNo">229</span> *<a name="line.229"></a> |
| <span class="sourceLineNo">230</span> * <h5 class='section'>Used for:</h5><a name="line.230"></a> |
| <span class="sourceLineNo">231</span> * <ul class='spaced-list'><a name="line.231"></a> |
| <span class="sourceLineNo">232</span> * <li><a name="line.232"></a> |
| <span class="sourceLineNo">233</span> * Server-side generated Swagger documentation.<a name="line.233"></a> |
| <span class="sourceLineNo">234</span> * </ul><a name="line.234"></a> |
| <span class="sourceLineNo">235</span> *<a name="line.235"></a> |
| <span class="sourceLineNo">236</span> * <ul class='seealso'><a name="line.236"></a> |
| <span class="sourceLineNo">237</span> * <li class='ja'>{@link Example}<a name="line.237"></a> |
| <span class="sourceLineNo">238</span> * <li class='jc'>{@link BeanContext}<a name="line.238"></a> |
| <span class="sourceLineNo">239</span> * <ul><a name="line.239"></a> |
| <span class="sourceLineNo">240</span> * <li class='jf'>{@link BeanContext#BEAN_examples BEAN_examples}<a name="line.240"></a> |
| <span class="sourceLineNo">241</span> * </ul><a name="line.241"></a> |
| <span class="sourceLineNo">242</span> * <li class='jc'>{@link JsonSchemaSerializer}<a name="line.242"></a> |
| <span class="sourceLineNo">243</span> * <ul><a name="line.243"></a> |
| <span class="sourceLineNo">244</span> * <li class='jf'>{@link JsonSchemaGenerator#JSONSCHEMA_addExamplesTo JSONSCHEMA_addExamplesTo}<a name="line.244"></a> |
| <span class="sourceLineNo">245</span> * <li class='jf'>{@link JsonSchemaGenerator#JSONSCHEMA_allowNestedExamples JSONSCHEMA_allowNestedExamples}<a name="line.245"></a> |
| <span class="sourceLineNo">246</span> * </ul><a name="line.246"></a> |
| <span class="sourceLineNo">247</span> * </ul><a name="line.247"></a> |
| <span class="sourceLineNo">248</span> *<a name="line.248"></a> |
| <span class="sourceLineNo">249</span> * <ul class='notes'><a name="line.249"></a> |
| <span class="sourceLineNo">250</span> * <li><a name="line.250"></a> |
| <span class="sourceLineNo">251</span> * The format is any {@doc SimpleJson} if the object can be converted to a POJO using {@link JsonParser#DEFAULT} or a simple String if the object<a name="line.251"></a> |
| <span class="sourceLineNo">252</span> * has a schema associated with it meancan be converted from a String.<a name="line.252"></a> |
| <span class="sourceLineNo">253</span> * <br>Multiple lines are concatenated with newlines.<a name="line.253"></a> |
| <span class="sourceLineNo">254</span> * <li><a name="line.254"></a> |
| <span class="sourceLineNo">255</span> * The format of this object can also be a simple String if the body has a schema associated with it, meaning it's meant to be treated as an HTTP part.<a name="line.255"></a> |
| <span class="sourceLineNo">256</span> * <li><a name="line.256"></a> |
| <span class="sourceLineNo">257</span> * Supports {@doc DefaultRestSvlVariables}<a name="line.257"></a> |
| <span class="sourceLineNo">258</span> * (e.g. <js>"$L{my.localized.variable}"</js>).<a name="line.258"></a> |
| <span class="sourceLineNo">259</span> * </ul><a name="line.259"></a> |
| <span class="sourceLineNo">260</span> */<a name="line.260"></a> |
| <span class="sourceLineNo">261</span> String[] example() default {};<a name="line.261"></a> |
| <span class="sourceLineNo">262</span><a name="line.262"></a> |
| <span class="sourceLineNo">263</span> /**<a name="line.263"></a> |
| <span class="sourceLineNo">264</span> * Serialized examples of the body of a response.<a name="line.264"></a> |
| <span class="sourceLineNo">265</span> *<a name="line.265"></a> |
| <span class="sourceLineNo">266</span> * <p><a name="line.266"></a> |
| <span class="sourceLineNo">267</span> * This is a {@doc SimpleJson} object whose keys are media types and values are string representations of that value.<a name="line.267"></a> |
| <span class="sourceLineNo">268</span> *<a name="line.268"></a> |
| <span class="sourceLineNo">269</span> * <p><a name="line.269"></a> |
| <span class="sourceLineNo">270</span> * In general you won't need to populate this value directly since it will automatically be calculated based on the value provided in the {@link #example()} field.<a name="line.270"></a> |
| <span class="sourceLineNo">271</span> * <br>However, this field allows you to override the behavior and show examples for only specified media types or different examples for different media types.<a name="line.271"></a> |
| <span class="sourceLineNo">272</span> *<a name="line.272"></a> |
| <span class="sourceLineNo">273</span> * <p class='bcode w800'><a name="line.273"></a> |
| <span class="sourceLineNo">274</span> * <jc>// A JSON representation of a PetCreate object.</jc><a name="line.274"></a> |
| <span class="sourceLineNo">275</span> * <ja>@Response</ja>(<a name="line.275"></a> |
| <span class="sourceLineNo">276</span> * examples={<a name="line.276"></a> |
| <span class="sourceLineNo">277</span> * <js>"'application/json':'{name:\\'Doggie\\',species:\\'Dog\\'}',"</js>,<a name="line.277"></a> |
| <span class="sourceLineNo">278</span> * <js>"'text/uon':'(name:Doggie,species=Dog)'"</js><a name="line.278"></a> |
| <span class="sourceLineNo">279</span> * }<a name="line.279"></a> |
| <span class="sourceLineNo">280</span> * )<a name="line.280"></a> |
| <span class="sourceLineNo">281</span> * </p><a name="line.281"></a> |
| <span class="sourceLineNo">282</span> *<a name="line.282"></a> |
| <span class="sourceLineNo">283</span> * <h5 class='section'>Used for:</h5><a name="line.283"></a> |
| <span class="sourceLineNo">284</span> * <ul class='spaced-list'><a name="line.284"></a> |
| <span class="sourceLineNo">285</span> * <li><a name="line.285"></a> |
| <span class="sourceLineNo">286</span> * Server-side generated Swagger documentation.<a name="line.286"></a> |
| <span class="sourceLineNo">287</span> * </ul><a name="line.287"></a> |
| <span class="sourceLineNo">288</span> *<a name="line.288"></a> |
| <span class="sourceLineNo">289</span> * <ul class='notes'><a name="line.289"></a> |
| <span class="sourceLineNo">290</span> * <li><a name="line.290"></a> |
| <span class="sourceLineNo">291</span> * The format is a {@doc SimpleJson} object with string keys (media type) and string values (example for that media type) .<a name="line.291"></a> |
| <span class="sourceLineNo">292</span> * <li><a name="line.292"></a> |
| <span class="sourceLineNo">293</span> * The leading/trailing <c>{ }</c> characters are optional.<a name="line.293"></a> |
| <span class="sourceLineNo">294</span> * <li><a name="line.294"></a> |
| <span class="sourceLineNo">295</span> * Multiple lines are concatenated with newlines so that you can format the value to be readable:<a name="line.295"></a> |
| <span class="sourceLineNo">296</span> * <li><a name="line.296"></a> |
| <span class="sourceLineNo">297</span> * Supports {@doc DefaultRestSvlVariables}<a name="line.297"></a> |
| <span class="sourceLineNo">298</span> * (e.g. <js>"$L{my.localized.variable}"</js>).<a name="line.298"></a> |
| <span class="sourceLineNo">299</span> * <li><a name="line.299"></a> |
| <span class="sourceLineNo">300</span> * Resolution of variables is delayed until request time and occurs before parsing.<a name="line.300"></a> |
| <span class="sourceLineNo">301</span> * <br>This allows you to, for example, pull in a JSON construct from a properties file based on the locale of the HTTP request.<a name="line.301"></a> |
| <span class="sourceLineNo">302</span> * </ul><a name="line.302"></a> |
| <span class="sourceLineNo">303</span> */<a name="line.303"></a> |
| <span class="sourceLineNo">304</span> String[] examples() default {};<a name="line.304"></a> |
| <span class="sourceLineNo">305</span><a name="line.305"></a> |
| <span class="sourceLineNo">306</span> /**<a name="line.306"></a> |
| <span class="sourceLineNo">307</span> * Free-form value for the {@doc SwaggerResponseObject}.<a name="line.307"></a> |
| <span class="sourceLineNo">308</span> *<a name="line.308"></a> |
| <span class="sourceLineNo">309</span> * <p><a name="line.309"></a> |
| <span class="sourceLineNo">310</span> * This is a {@doc SimpleJson} object that makes up the swagger information for this field.<a name="line.310"></a> |
| <span class="sourceLineNo">311</span> *<a name="line.311"></a> |
| <span class="sourceLineNo">312</span> * <p><a name="line.312"></a> |
| <span class="sourceLineNo">313</span> * The following are completely equivalent ways of defining the swagger description of the Response object:<a name="line.313"></a> |
| <span class="sourceLineNo">314</span> * <p class='bcode w800'><a name="line.314"></a> |
| <span class="sourceLineNo">315</span> * <jc>// Normal</jc><a name="line.315"></a> |
| <span class="sourceLineNo">316</span> * <ja>@Response</ja>(<a name="line.316"></a> |
| <span class="sourceLineNo">317</span> * code=302,<a name="line.317"></a> |
| <span class="sourceLineNo">318</span> * description=<js>"Redirect"</js>,<a name="line.318"></a> |
| <span class="sourceLineNo">319</span> * headers={<a name="line.319"></a> |
| <span class="sourceLineNo">320</span> * <ja>@ResponseHeader</ja>(<a name="line.320"></a> |
| <span class="sourceLineNo">321</span> * name=<js>"Location"</js>,<a name="line.321"></a> |
| <span class="sourceLineNo">322</span> * type=<js>"string"</js>,<a name="line.322"></a> |
| <span class="sourceLineNo">323</span> * format=<js>"uri"</js><a name="line.323"></a> |
| <span class="sourceLineNo">324</span> * )<a name="line.324"></a> |
| <span class="sourceLineNo">325</span> * }<a name="line.325"></a> |
| <span class="sourceLineNo">326</span> * )<a name="line.326"></a> |
| <span class="sourceLineNo">327</span> * </p><a name="line.327"></a> |
| <span class="sourceLineNo">328</span> * <p class='bcode w800'><a name="line.328"></a> |
| <span class="sourceLineNo">329</span> * <jc>// Free-form</jc><a name="line.329"></a> |
| <span class="sourceLineNo">330</span> * <ja>@Response</ja>(<a name="line.330"></a> |
| <span class="sourceLineNo">331</span> * code=302,<a name="line.331"></a> |
| <span class="sourceLineNo">332</span> * api={<a name="line.332"></a> |
| <span class="sourceLineNo">333</span> * <js>"description: 'Redirect',"</js>,<a name="line.333"></a> |
| <span class="sourceLineNo">334</span> * <js>"headers: {"</js>,<a name="line.334"></a> |
| <span class="sourceLineNo">335</span> * <js>"Location: {"</js>,<a name="line.335"></a> |
| <span class="sourceLineNo">336</span> * <js>"type: 'string',"</js>,<a name="line.336"></a> |
| <span class="sourceLineNo">337</span> * <js>"format: 'uri'"</js>,<a name="line.337"></a> |
| <span class="sourceLineNo">338</span> * <js>"}"</js>,<a name="line.338"></a> |
| <span class="sourceLineNo">339</span> * <js>"}"</js><a name="line.339"></a> |
| <span class="sourceLineNo">340</span> * }<a name="line.340"></a> |
| <span class="sourceLineNo">341</span> * )<a name="line.341"></a> |
| <span class="sourceLineNo">342</span> * </p><a name="line.342"></a> |
| <span class="sourceLineNo">343</span> * <p class='bcode w800'><a name="line.343"></a> |
| <span class="sourceLineNo">344</span> * <jc>// Free-form using variables</jc><a name="line.344"></a> |
| <span class="sourceLineNo">345</span> * <ja>@Response</ja>(<a name="line.345"></a> |
| <span class="sourceLineNo">346</span> * code=302,<a name="line.346"></a> |
| <span class="sourceLineNo">347</span> * api=<js>"$L{redirectSwagger}"</js><a name="line.347"></a> |
| <span class="sourceLineNo">348</span> * )<a name="line.348"></a> |
| <span class="sourceLineNo">349</span> * </p><a name="line.349"></a> |
| <span class="sourceLineNo">350</span> * <p class='bcode w800'><a name="line.350"></a> |
| <span class="sourceLineNo">351</span> * <mc>// Contents of MyResource.properties</mc><a name="line.351"></a> |
| <span class="sourceLineNo">352</span> * <mk>redirectSwagger</mk> = <mv>{ description: "Redirect", headers: { Location: { type: "string", format: "uri" } } }</mv><a name="line.352"></a> |
| <span class="sourceLineNo">353</span> * </p><a name="line.353"></a> |
| <span class="sourceLineNo">354</span> *<a name="line.354"></a> |
| <span class="sourceLineNo">355</span> * <p><a name="line.355"></a> |
| <span class="sourceLineNo">356</span> * The reasons why you may want to use this field include:<a name="line.356"></a> |
| <span class="sourceLineNo">357</span> * <ul><a name="line.357"></a> |
| <span class="sourceLineNo">358</span> * <li>You want to pull in the entire Swagger JSON definition for this field from an external source such as a properties file.<a name="line.358"></a> |
| <span class="sourceLineNo">359</span> * <li>You want to add extra fields to the Swagger documentation that are not officially part of the Swagger specification.<a name="line.359"></a> |
| <span class="sourceLineNo">360</span> * </ul><a name="line.360"></a> |
| <span class="sourceLineNo">361</span> *<a name="line.361"></a> |
| <span class="sourceLineNo">362</span> * <h5 class='section'>Used for:</h5><a name="line.362"></a> |
| <span class="sourceLineNo">363</span> * <ul class='spaced-list'><a name="line.363"></a> |
| <span class="sourceLineNo">364</span> * <li><a name="line.364"></a> |
| <span class="sourceLineNo">365</span> * Server-side generated Swagger documentation.<a name="line.365"></a> |
| <span class="sourceLineNo">366</span> * </ul><a name="line.366"></a> |
| <span class="sourceLineNo">367</span> *<a name="line.367"></a> |
| <span class="sourceLineNo">368</span> * <ul class='notes'><a name="line.368"></a> |
| <span class="sourceLineNo">369</span> * <li><a name="line.369"></a> |
| <span class="sourceLineNo">370</span> * Note that the only swagger field you can't specify using this value is <js>"code"</js> whose value needs to be known during servlet initialization.<a name="line.370"></a> |
| <span class="sourceLineNo">371</span> * <li><a name="line.371"></a> |
| <span class="sourceLineNo">372</span> * The format is a {@doc SimpleJson} object.<a name="line.372"></a> |
| <span class="sourceLineNo">373</span> * <li><a name="line.373"></a> |
| <span class="sourceLineNo">374</span> * The leading/trailing <c>{ }</c> characters are optional.<a name="line.374"></a> |
| <span class="sourceLineNo">375</span> * <br>The following two example are considered equivalent:<a name="line.375"></a> |
| <span class="sourceLineNo">376</span> * <p class='bcode w800'><a name="line.376"></a> |
| <span class="sourceLineNo">377</span> * <ja>@Response</ja>(api=<js>"{description: 'Redirect'}"</js>)<a name="line.377"></a> |
| <span class="sourceLineNo">378</span> * </p><a name="line.378"></a> |
| <span class="sourceLineNo">379</span> * <p class='bcode w800'><a name="line.379"></a> |
| <span class="sourceLineNo">380</span> * <ja>@Response</ja>(api=<js>"description: 'Redirect''"</js>)<a name="line.380"></a> |
| <span class="sourceLineNo">381</span> * </p><a name="line.381"></a> |
| <span class="sourceLineNo">382</span> * <li><a name="line.382"></a> |
| <span class="sourceLineNo">383</span> * Multiple lines are concatenated with newlines so that you can format the value to be readable.<a name="line.383"></a> |
| <span class="sourceLineNo">384</span> * <li><a name="line.384"></a> |
| <span class="sourceLineNo">385</span> * Supports {@doc DefaultRestSvlVariables}<a name="line.385"></a> |
| <span class="sourceLineNo">386</span> * (e.g. <js>"$L{my.localized.variable}"</js>).<a name="line.386"></a> |
| <span class="sourceLineNo">387</span> * <li><a name="line.387"></a> |
| <span class="sourceLineNo">388</span> * Values defined in this field supersede values pulled from the Swagger JSON file and are superseded by individual values defined on this annotation.<a name="line.388"></a> |
| <span class="sourceLineNo">389</span> * </ul><a name="line.389"></a> |
| <span class="sourceLineNo">390</span> */<a name="line.390"></a> |
| <span class="sourceLineNo">391</span> String[] api() default {};<a name="line.391"></a> |
| <span class="sourceLineNo">392</span>}<a name="line.392"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |