org.apache.juneau.examples.rest.dto

Class JsonSchemaResource

java.lang.Object

javax.servlet.GenericServlet

javax.servlet.http.HttpServlet

org.apache.juneau.rest.RestServlet

org.apache.juneau.rest.BasicRestServlet

org.apache.juneau.rest.BasicRestServletJena

org.apache.juneau.examples.rest.dto.JsonSchemaResource

All Implemented Interfaces:

Serializable, Servlet, ServletConfig, BasicRestConfig

@Rest(path="/jsonSchema",
      messages="nls/JsonSchemaResource",
      title="Sample JSON-Schema document",
      description="Sample resource that shows how to generate JSON-Schema documents",
      swagger=)
 @HtmlDocConfig(widgets={ContentTypeMenuItem.class,ThemeMenuItem.class},
               navlinks={"up: request:/..","options: servlet:/?method=OPTIONS","$W{ContentTypeMenuItem}","$W{ThemeMenuItem}","source: $C{Source/gitHub}/org/apache/juneau/examples/rest/dto/$R{servletClassSimple}.java"},
               aside={"<div style=\'min-width:200px\' class=\'text\'>","\t<p>Shows how to produce JSON-Schema documents in a variety of languages using the JSON-Schema DTOs.</p>","</div>"})
 @BeanConfig(examples="Schema: $F{JsonSchemaResource_example.json}")
public class JsonSchemaResource
extends BasicRestServletJena

Sample resource that shows how to serialize JSON-Schema documents.

• Source

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
JsonSchemaResource()

Method Summary

Modifier and Type	Method and Description
JsonSchema	get() Get the JSON-Schema document.
void	init()
JsonSchema	put(JsonSchema schema) Overwrite the JSON-Schema document

Methods inherited from class org.apache.juneau.rest.BasicRestServlet

getOptions

Methods inherited from class org.apache.juneau.rest.RestServlet

destroy, getContext, getPath, getProperties, getRequest, getResponse, getServletConfig, init, log, log, log, log, logObjects, service, setContext, setRestResourceResolver

Methods inherited from class javax.servlet.http.HttpServlet

doDelete, doGet, doHead, doOptions, doPost, doPut, doTrace, getLastModified, service

Methods inherited from class javax.servlet.GenericServlet

getInitParameter, getInitParameterNames, getServletContext, getServletInfo, getServletName

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JsonSchemaResource

public JsonSchemaResource()

Method Detail

init

public void init()

Overrides:

init in class GenericServlet

get

@RestMethod(summary="Get the JSON-Schema document")
public JsonSchema get()

Get the JSON-Schema document.

Returns:

The JSON-Schema document.

put

@RestMethod(summary="Overwrite the JSON-Schema document",
            description="Replaces the schema document with the specified content, and then mirrors it as the response.")
public JsonSchema put(@Body
                                                                                                                                                                                                         JsonSchema schema)

Overwrite the JSON-Schema document

Parameters:

schema - The new schema document.

Returns:

The updated schema document.