Package org.apache.juneau.dto.swagger

Class SwaggerBuilder

java.lang.Object

org.apache.juneau.dto.swagger.SwaggerBuilder

public class SwaggerBuilder
extends Object

Various useful static methods for creating Swagger elements.

See Also:

• Overview > juneau-rest-server > Swagger

Constructor Summary

Constructors

Constructor	Description
SwaggerBuilder()

Method Summary

Modifier and Type	Method	Description
static final Contact	contact()	Creates an empty Contact element.
static final Contact	contact(String name)	Creates an Contact element with the specified name attribute.
static final Contact	contact(String name, Object url, String email)	Creates an Contact element with the specified name, url, and email attributes.
static final ExternalDocumentation	externalDocumentation()	Creates an empty ExternalDocumentation element.
static final ExternalDocumentation	externalDocumentation(Object url)	Creates an ExternalDocumentation element with the specified url attribute.
static final ExternalDocumentation	externalDocumentation(Object url, String description)	Creates an ExternalDocumentation element with the specified url and description attributes.
static final HeaderInfo	headerInfo()	Creates an empty HeaderInfo element.
static final HeaderInfo	headerInfo(String type)	Creates an HeaderInfo element with the specified type attribute.
static final HeaderInfo	headerInfoStrict(String type)	Creates an HeaderInfo element with the specified type attribute.
static final Info	info()	Creates an empty Info element.
static final Info	info(String title, String version)	Creates an Info element with the specified title and version attributes.
static final Items	items()	Creates an empty Items element.
static final Items	items(String type)	Creates an Items element with the specified type attribute.
static final Items	itemsStrict(String type)	Creates an Items element with the specified type attribute.
static final License	license()	Creates an empty License element.
static final License	license(String name)	Creates an License element with the specified name attribute.
static final License	license(String name, URI url)	Creates an License element with the specified name and url attributes.
static final Operation	operation()	Creates an empty Operation element.
static final ParameterInfo	parameterInfo()	Creates an empty ParameterInfo element.
static final ParameterInfo	parameterInfo(String in, String name)	Creates an ParameterInfo element with the specified in and name attributes.
static final ParameterInfo	parameterInfoStrict(String in, String name)	Creates an ParameterInfo element with the specified in and name attributes.
static final ResponseInfo	responseInfo()	Creates an empty ResponseInfo element.
static final ResponseInfo	responseInfo(String description)	Creates an ResponseInfo element with the specified description attribute.
static final SchemaInfo	schemaInfo()	Creates an empty SchemaInfo element.
static final SecurityScheme	securityScheme()	Creates an empty SecurityScheme element.
static final SecurityScheme	securityScheme(String type)	Creates an SecurityScheme element with the specified type attribute.
static final SecurityScheme	securitySchemeStrict(String type)	Creates an SecurityScheme element with the specified type attribute.
static final Swagger	swagger()	Creates an empty Swagger element.
static final Swagger	swagger(Info info)	Creates an Swagger element with the specified info attribute.
static final Tag	tag()	Creates an empty Tag element.
static final Tag	tag(String name)	Creates an Tag element with the specified name attribute.
static final Xml	xml()	Creates an empty Xml element.

Methods inherited from class java.lang.Object

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

Constructor Details

SwaggerBuilder

public SwaggerBuilder()

Method Details

contact

public static final Contact contact()

Creates an empty Contact element.

Returns:

The new element.

contact

public static final Contact contact(String name)

Creates an Contact element with the specified name attribute.

Parameters:

name - The name attribute.

Returns:

The new element.

contact

public static final Contact contact(String name,
 Object url,
 String email)

Creates an Contact element with the specified name, url, and email attributes.

Parameters:

name - The name attribute.

url - The url attribute.
The value can be of any of the following types: URI, URL, String.
Strings must be valid URIs.
URIs defined by UriResolver can be used for values.

email - The email attribute.

Returns:

The new element.

externalDocumentation

public static final ExternalDocumentation externalDocumentation()

Creates an empty ExternalDocumentation element.

Returns:

The new element.

externalDocumentation

public static final ExternalDocumentation externalDocumentation(Object url)

Creates an ExternalDocumentation element with the specified url attribute.

Parameters:

url - The url attribute.
The value can be of any of the following types: URI, URL, String.
Strings must be valid URIs.
URIs defined by UriResolver can be used for values.

Returns:

The new element.

externalDocumentation

public static final ExternalDocumentation externalDocumentation(Object url,
 String description)

Creates an ExternalDocumentation element with the specified url and description attributes.

Parameters:

url - The url attribute.
The value can be of any of the following types: URI, URL, String.
Strings must be valid URIs.
URIs defined by UriResolver can be used for values.

description - The description attribute.

Returns:

The new element.

headerInfo

public static final HeaderInfo headerInfo()

Creates an empty HeaderInfo element.

Returns:

The new element.

headerInfo

public static final HeaderInfo headerInfo(String type)

Creates an HeaderInfo element with the specified type attribute.

Parameters:

type - The type attribute.

Returns:

The new element.

headerInfoStrict

public static final HeaderInfo headerInfoStrict(String type)

Creates an HeaderInfo element with the specified type attribute.

Throws a runtime exception if the type is not valid.

Parameters:

type - The type attribute.
Valid values:

• "string"
• "number"
• "integer"
• "boolean"
• "array"

Returns:

The new element.

info

public static final Info info()

Creates an empty Info element.

Returns:

The new element.

info

public static final Info info(String title,
 String version)

Creates an Info element with the specified title and version attributes.

Parameters:

title - The title attribute.

version - The version attribute.

Returns:

The new element.

items

public static final Items items()

Creates an empty Items element.

Returns:

The new element.

items

public static final Items items(String type)

Creates an Items element with the specified type attribute.

Parameters:

type - The type attribute.

Returns:

The new element.

itemsStrict

public static final Items itemsStrict(String type)

Creates an Items element with the specified type attribute.

Throws a runtime exception if the type is not valid.

Parameters:

type - The type attribute.
Valid values:

• "string"
• "number"
• "integer"
• "boolean"
• "array"

Returns:

The new element.

license

public static final License license()

Creates an empty License element.

Returns:

The new element.

license

public static final License license(String name)

Creates an License element with the specified name attribute.

Parameters:

name - The name attribute.

Returns:

The new element.

license

public static final License license(String name,
 URI url)

Creates an License element with the specified name and url attributes.

Parameters:

name - The name attribute.

url - The url attribute.

Returns:

The new element.

operation

public static final Operation operation()

Creates an empty Operation element.

Returns:

The new element.

parameterInfo

public static final ParameterInfo parameterInfo()

Creates an empty ParameterInfo element.

Returns:

The new element.

parameterInfo

public static final ParameterInfo parameterInfo(String in,
 String name)

Creates an ParameterInfo element with the specified in and name attributes.

Parameters:

in - The in attribute.

name - The name attribute.

Returns:

The new element.

parameterInfoStrict

public static final ParameterInfo parameterInfoStrict(String in,
 String name)

Creates an ParameterInfo element with the specified in and name attributes.

Throws a runtime exception if the type is not valid.

Parameters:

in - The in attribute.
Valid values:

• "query"
• "header"
• "path"
• "formData"
• "body"

name - The name attribute.

Returns:

The new element.

responseInfo

public static final ResponseInfo responseInfo()

Creates an empty ResponseInfo element.

Returns:

The new element.

responseInfo

public static final ResponseInfo responseInfo(String description)

Creates an ResponseInfo element with the specified description attribute.

Parameters:

description - The description attribute.

Returns:

The new element.

schemaInfo

public static final SchemaInfo schemaInfo()

Creates an empty SchemaInfo element.

Returns:

The new element.

securityScheme

public static final SecurityScheme securityScheme()

Creates an empty SecurityScheme element.

Returns:

The new element.

securityScheme

public static final SecurityScheme securityScheme(String type)

Creates an SecurityScheme element with the specified type attribute.

Parameters:

type - The type attribute.

Returns:

The new element.

securitySchemeStrict

public static final SecurityScheme securitySchemeStrict(String type)

Creates an SecurityScheme element with the specified type attribute.

Throws a runtime exception if the type is not valid.

Parameters:

type - The type attribute.
Valid values:

• "basic"
• "apiKey"
• "oauth2"

Returns:

The new element.

swagger

public static final Swagger swagger()

Creates an empty Swagger element.

Returns:

The new element.

swagger

public static final Swagger swagger(Info info)

Creates an Swagger element with the specified info attribute.

Parameters:

info - The info attribute.

Returns:

The new element.

tag

public static final Tag tag()

Creates an empty Tag element.

Returns:

The new element.

tag

public static final Tag tag(String name)

Creates an Tag element with the specified name attribute.

Parameters:

name - The name attribute.

Returns:

The new element.

xml

public static final Xml xml()

Creates an empty Xml element.

Returns:

The new element.