| <!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.examples.rest.dto;<a name="line.13"></a> |
| <span class="sourceLineNo">014</span><a name="line.14"></a> |
| <span class="sourceLineNo">015</span>import org.apache.juneau.annotation.*;<a name="line.15"></a> |
| <span class="sourceLineNo">016</span>import org.apache.juneau.dto.jsonschema.*;<a name="line.16"></a> |
| <span class="sourceLineNo">017</span>import org.apache.juneau.html.annotation.*;<a name="line.17"></a> |
| <span class="sourceLineNo">018</span>import org.apache.juneau.http.annotation.*;<a name="line.18"></a> |
| <span class="sourceLineNo">019</span>import org.apache.juneau.rest.annotation.*;<a name="line.19"></a> |
| <span class="sourceLineNo">020</span>import org.apache.juneau.rest.servlet.*;<a name="line.20"></a> |
| <span class="sourceLineNo">021</span>import org.apache.juneau.rest.widget.*;<a name="line.21"></a> |
| <span class="sourceLineNo">022</span><a name="line.22"></a> |
| <span class="sourceLineNo">023</span>/**<a name="line.23"></a> |
| <span class="sourceLineNo">024</span> * Sample resource that shows how to serialize JSON-Schema documents.<a name="line.24"></a> |
| <span class="sourceLineNo">025</span> *<a name="line.25"></a> |
| <span class="sourceLineNo">026</span> * <ul class='seealso'><a name="line.26"></a> |
| <span class="sourceLineNo">027</span> * <li class='extlink'>{@source}<a name="line.27"></a> |
| <span class="sourceLineNo">028</span> * </ul><a name="line.28"></a> |
| <span class="sourceLineNo">029</span> *<a name="line.29"></a> |
| <span class="sourceLineNo">030</span> * @serial exclude<a name="line.30"></a> |
| <span class="sourceLineNo">031</span> */<a name="line.31"></a> |
| <span class="sourceLineNo">032</span>@Rest(<a name="line.32"></a> |
| <span class="sourceLineNo">033</span> path="/jsonSchema",<a name="line.33"></a> |
| <span class="sourceLineNo">034</span> messages="nls/JsonSchemaResource",<a name="line.34"></a> |
| <span class="sourceLineNo">035</span> title="Sample JSON-Schema document",<a name="line.35"></a> |
| <span class="sourceLineNo">036</span> description="Sample resource that shows how to generate JSON-Schema documents",<a name="line.36"></a> |
| <span class="sourceLineNo">037</span> swagger=@Swagger(<a name="line.37"></a> |
| <span class="sourceLineNo">038</span> contact=@Contact(name="Juneau Developer",email="dev@juneau.apache.org"),<a name="line.38"></a> |
| <span class="sourceLineNo">039</span> license=@License(name="Apache 2.0",url="http://www.apache.org/licenses/LICENSE-2.0.html"),<a name="line.39"></a> |
| <span class="sourceLineNo">040</span> version="2.0",<a name="line.40"></a> |
| <span class="sourceLineNo">041</span> termsOfService="You are on your own.",<a name="line.41"></a> |
| <span class="sourceLineNo">042</span> externalDocs=@ExternalDocs(description="Apache Juneau",url="http://juneau.apache.org")<a name="line.42"></a> |
| <span class="sourceLineNo">043</span> )<a name="line.43"></a> |
| <span class="sourceLineNo">044</span>)<a name="line.44"></a> |
| <span class="sourceLineNo">045</span>@HtmlDocConfig(<a name="line.45"></a> |
| <span class="sourceLineNo">046</span> widgets={<a name="line.46"></a> |
| <span class="sourceLineNo">047</span> ContentTypeMenuItem.class<a name="line.47"></a> |
| <span class="sourceLineNo">048</span> },<a name="line.48"></a> |
| <span class="sourceLineNo">049</span> navlinks={<a name="line.49"></a> |
| <span class="sourceLineNo">050</span> "up: request:/..",<a name="line.50"></a> |
| <span class="sourceLineNo">051</span> "api: servlet:/api",<a name="line.51"></a> |
| <span class="sourceLineNo">052</span> "stats: servlet:/stats",<a name="line.52"></a> |
| <span class="sourceLineNo">053</span> "$W{ContentTypeMenuItem}",<a name="line.53"></a> |
| <span class="sourceLineNo">054</span> "source: $C{Source/gitHub}/org/apache/juneau/examples/rest/dto/JsonSchemaResource.java"<a name="line.54"></a> |
| <span class="sourceLineNo">055</span> },<a name="line.55"></a> |
| <span class="sourceLineNo">056</span> aside={<a name="line.56"></a> |
| <span class="sourceLineNo">057</span> "<div style='min-width:200px' class='text'>",<a name="line.57"></a> |
| <span class="sourceLineNo">058</span> " <p>Shows how to produce JSON-Schema documents in a variety of languages using the JSON-Schema DTOs.</p>",<a name="line.58"></a> |
| <span class="sourceLineNo">059</span> "</div>"<a name="line.59"></a> |
| <span class="sourceLineNo">060</span> }<a name="line.60"></a> |
| <span class="sourceLineNo">061</span>)<a name="line.61"></a> |
| <span class="sourceLineNo">062</span>@Marshalled(on="Schema",example="$F{JsonSchemaResource_example.json}")<a name="line.62"></a> |
| <span class="sourceLineNo">063</span>public class JsonSchemaResource extends BasicRestServlet {<a name="line.63"></a> |
| <span class="sourceLineNo">064</span> private static final long serialVersionUID = 1L;<a name="line.64"></a> |
| <span class="sourceLineNo">065</span><a name="line.65"></a> |
| <span class="sourceLineNo">066</span> private JsonSchema schema; // The schema document<a name="line.66"></a> |
| <span class="sourceLineNo">067</span><a name="line.67"></a> |
| <span class="sourceLineNo">068</span> @Override /* Servlet */<a name="line.68"></a> |
| <span class="sourceLineNo">069</span> public void init() {<a name="line.69"></a> |
| <span class="sourceLineNo">070</span><a name="line.70"></a> |
| <span class="sourceLineNo">071</span> try {<a name="line.71"></a> |
| <span class="sourceLineNo">072</span> schema = new JsonSchema()<a name="line.72"></a> |
| <span class="sourceLineNo">073</span> .setId("http://example.com/sample-schema#")<a name="line.73"></a> |
| <span class="sourceLineNo">074</span> .setSchemaVersionUri("http://json-schema.org/draft-04/schema#")<a name="line.74"></a> |
| <span class="sourceLineNo">075</span> .setTitle("Example Schema")<a name="line.75"></a> |
| <span class="sourceLineNo">076</span> .setType(JsonType.OBJECT)<a name="line.76"></a> |
| <span class="sourceLineNo">077</span> .addProperties(<a name="line.77"></a> |
| <span class="sourceLineNo">078</span> new JsonSchemaProperty("firstName", JsonType.STRING),<a name="line.78"></a> |
| <span class="sourceLineNo">079</span> new JsonSchemaProperty("lastName", JsonType.STRING),<a name="line.79"></a> |
| <span class="sourceLineNo">080</span> new JsonSchemaProperty("age", JsonType.INTEGER)<a name="line.80"></a> |
| <span class="sourceLineNo">081</span> .setDescription("Age in years")<a name="line.81"></a> |
| <span class="sourceLineNo">082</span> .setMinimum(0)<a name="line.82"></a> |
| <span class="sourceLineNo">083</span> )<a name="line.83"></a> |
| <span class="sourceLineNo">084</span> .addRequired("firstName", "lastName");<a name="line.84"></a> |
| <span class="sourceLineNo">085</span> } catch (Exception e) {<a name="line.85"></a> |
| <span class="sourceLineNo">086</span> throw new RuntimeException(e);<a name="line.86"></a> |
| <span class="sourceLineNo">087</span> }<a name="line.87"></a> |
| <span class="sourceLineNo">088</span> }<a name="line.88"></a> |
| <span class="sourceLineNo">089</span><a name="line.89"></a> |
| <span class="sourceLineNo">090</span> /**<a name="line.90"></a> |
| <span class="sourceLineNo">091</span> * [HTTP GET /dto/jsonSchema]<a name="line.91"></a> |
| <span class="sourceLineNo">092</span> * Get the JSON-Schema document.<a name="line.92"></a> |
| <span class="sourceLineNo">093</span> *<a name="line.93"></a> |
| <span class="sourceLineNo">094</span> * @return The JSON-Schema document.<a name="line.94"></a> |
| <span class="sourceLineNo">095</span> */<a name="line.95"></a> |
| <span class="sourceLineNo">096</span> @RestGet(<a name="line.96"></a> |
| <span class="sourceLineNo">097</span> summary="Get the JSON-Schema document"<a name="line.97"></a> |
| <span class="sourceLineNo">098</span> )<a name="line.98"></a> |
| <span class="sourceLineNo">099</span> public JsonSchema get() {<a name="line.99"></a> |
| <span class="sourceLineNo">100</span> return schema;<a name="line.100"></a> |
| <span class="sourceLineNo">101</span> }<a name="line.101"></a> |
| <span class="sourceLineNo">102</span><a name="line.102"></a> |
| <span class="sourceLineNo">103</span> /**<a name="line.103"></a> |
| <span class="sourceLineNo">104</span> * [HTTP PUT /dto/jsonSchema]<a name="line.104"></a> |
| <span class="sourceLineNo">105</span> * Overwrite the JSON-Schema document<a name="line.105"></a> |
| <span class="sourceLineNo">106</span> *<a name="line.106"></a> |
| <span class="sourceLineNo">107</span> * @param schema The new schema document.<a name="line.107"></a> |
| <span class="sourceLineNo">108</span> * @return The updated schema document.<a name="line.108"></a> |
| <span class="sourceLineNo">109</span> */<a name="line.109"></a> |
| <span class="sourceLineNo">110</span> @RestPut(<a name="line.110"></a> |
| <span class="sourceLineNo">111</span> summary="Overwrite the JSON-Schema document",<a name="line.111"></a> |
| <span class="sourceLineNo">112</span> description="Replaces the schema document with the specified content, and then mirrors it as the response."<a name="line.112"></a> |
| <span class="sourceLineNo">113</span> )<a name="line.113"></a> |
| <span class="sourceLineNo">114</span> public JsonSchema put(@Content JsonSchema schema) {<a name="line.114"></a> |
| <span class="sourceLineNo">115</span> this.schema = schema;<a name="line.115"></a> |
| <span class="sourceLineNo">116</span> return schema;<a name="line.116"></a> |
| <span class="sourceLineNo">117</span> }<a name="line.117"></a> |
| <span class="sourceLineNo">118</span>}<a name="line.118"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
