Package org.apache.juneau.bean.openapi3

Class OpenApiBuilder

java.lang.Object

org.apache.juneau.bean.openapi3.OpenApiBuilder

public class OpenApiBuilder
extends Object

Various useful static methods for creating OpenAPI elements.

See Also:

• juneau-bean-openapi-v3

Method Summary

Modifier and Type	Method	Description
static final Callback	callback()	Creates an empty Callback element.
static final Components	components()	Creates an empty Components element.
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 Discriminator	discriminator()	Creates an empty Discriminator element.
static final Discriminator	discriminator(String propertyName)	Creates a Discriminator element with the specified propertyName attribute.
static final Encoding	encoding()	Creates an empty Encoding element.
static final Encoding	encoding(String contentType)	Creates an Encoding element with the specified contentType attribute.
static final Example	example()	Creates an empty Example element.
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(SchemaInfo schema)	Creates an HeaderInfo element with the specified schema 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 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 Link	link()	Creates an empty Link element.
static final MediaType	mediaType()	Creates an empty MediaType element.
static final OAuthFlow	oAuthFlow()	Creates an empty OAuthFlow element.
static final OAuthFlows	oAuthFlows()	Creates an empty OAuthFlows element.
static final OpenApi	openApi()	Creates an empty OpenApi element.
static final OpenApi	openApi(Info info)	Creates an OpenApi element with the specified info attribute.
static final Operation	operation()	Creates an empty Operation element.
static final Parameter	parameter()	Creates an empty Parameter element.
static final Parameter	parameter(String in, String name)	Creates a Parameter element with the specified in and name attributes.
static final PathItem	pathItem()	Creates an empty PathItem element.
static final RequestBodyInfo	requestBodyInfo()	Creates an empty RequestBodyInfo element.
static final Response	response()	Creates an empty Response element.
static final Response	response(String description)	Creates a Response element with the specified description attribute.
static final SchemaInfo	schemaInfo()	Creates an empty SchemaInfo element.
static final SchemaInfo	schemaInfo(String type)	Creates an SchemaInfo element with the specified type attribute.
static final SecurityRequirement	securityRequirement()	Creates an empty SecurityRequirement element.
static final SecuritySchemeInfo	securitySchemeInfo()	Creates an empty SecuritySchemeInfo element.
static final SecuritySchemeInfo	securitySchemeInfo(String type)	Creates an SecuritySchemeInfo element with the specified type attribute.
static final Server	server()	Creates an empty Server element.
static final Server	server(URI url)	Creates an Server element with the specified url attribute.
static final ServerVariable	serverVariable()	Creates an empty ServerVariable element.
static final ServerVariable	serverVariable(String defaultValue)	Creates a ServerVariable element with the specified default 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

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(SchemaInfo schema)

Creates an HeaderInfo element with the specified schema attribute.

Parameters:

schema - The schema attribute.

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.

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.

openApi

public static final OpenApi openApi()

Creates an empty OpenApi element.

Returns:

The new element.

openApi

public static final OpenApi openApi(Info info)

Creates an OpenApi element with the specified info attribute.

Parameters:

info - The info attribute.

Returns:

The new element.

schemaInfo

public static final SchemaInfo schemaInfo()

Creates an empty SchemaInfo element.

Returns:

The new element.

schemaInfo

public static final SchemaInfo schemaInfo(String type)

Creates an SchemaInfo element with the specified type attribute.

Parameters:

type - The type attribute.

Returns:

The new element.

securitySchemeInfo

public static final SecuritySchemeInfo securitySchemeInfo()

Creates an empty SecuritySchemeInfo element.

Returns:

The new element.

securitySchemeInfo

public static final SecuritySchemeInfo securitySchemeInfo(String type)

Creates an SecuritySchemeInfo element with the specified type attribute.

Parameters:

type - The type attribute.

Returns:

The new element.

server

public static final Server server()

Creates an empty Server element.

Returns:

The new element.

server

public static final Server server(URI url)

Creates an Server element with the specified url attribute.

Parameters:

url - The url 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.

operation

public static final Operation operation()

Creates an empty Operation element.

Returns:

The new element.

parameter

public static final Parameter parameter()

Creates an empty Parameter element.

Returns:

The new element.

parameter

public static final Parameter parameter(String in,
 String name)

Creates a Parameter element with the specified in and name attributes.

Parameters:

in - The in attribute.

name - The name attribute.

Returns:

The new element.

pathItem

public static final PathItem pathItem()

Creates an empty PathItem element.

Returns:

The new element.

response

public static final Response response()

Creates an empty Response element.

Returns:

The new element.

response

public static final Response response(String description)

Creates a Response element with the specified description attribute.

Parameters:

description - The description attribute.

Returns:

The new element.

components

public static final Components components()

Creates an empty Components element.

Returns:

The new element.

securityRequirement

public static final SecurityRequirement securityRequirement()

Creates an empty SecurityRequirement element.

Returns:

The new element.

requestBodyInfo

public static final RequestBodyInfo requestBodyInfo()

Creates an empty RequestBodyInfo element.

Returns:

The new element.

example

public static final Example example()

Creates an empty Example element.

Returns:

The new element.

link

public static final Link link()

Creates an empty Link element.

Returns:

The new element.

callback

public static final Callback callback()

Creates an empty Callback element.

Returns:

The new element.

discriminator

public static final Discriminator discriminator()

Creates an empty Discriminator element.

Returns:

The new element.

discriminator

public static final Discriminator discriminator(String propertyName)

Creates a Discriminator element with the specified propertyName attribute.

Parameters:

propertyName - The propertyName attribute.

Returns:

The new element.

encoding

public static final Encoding encoding()

Creates an empty Encoding element.

Returns:

The new element.

encoding

public static final Encoding encoding(String contentType)

Creates an Encoding element with the specified contentType attribute.

Parameters:

contentType - The contentType attribute.

Returns:

The new element.

mediaType

public static final MediaType mediaType()

Creates an empty MediaType element.

Returns:

The new element.

oAuthFlow

public static final OAuthFlow oAuthFlow()

Creates an empty OAuthFlow element.

Returns:

The new element.

oAuthFlows

public static final OAuthFlows oAuthFlows()

Creates an empty OAuthFlows element.

Returns:

The new element.

serverVariable

public static final ServerVariable serverVariable()

Creates an empty ServerVariable element.

Returns:

The new element.

serverVariable

public static final ServerVariable serverVariable(String defaultValue)

Creates a ServerVariable element with the specified default attribute.

Parameters:

defaultValue - The default attribute.

Returns:

The new element.