Swagger (Apache Juneau 7.1.1)

java.lang.Object
- org.apache.juneau.dto.swagger.SwaggerElement
- - org.apache.juneau.dto.swagger.Swagger

@Bean(properties="swagger,info,tags,externalDocs,basePath,schemes,consumes,produces,paths,definitions,parameters,responses,securityDefinitions,security,*")
public class Swagger
extends SwaggerElement

This is the root document object for the API specification.

Fields
Modifier and Type	Field and Description
`static Swagger`	`NULL` Represents a null swagger

Constructors
Constructor and Description
`Swagger()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Swagger`	`addConsumes(Collection<MediaType> values)` Adds one or more values to the consumes property.
`Swagger`	`addDefinitions(Map<String,SchemaInfo> values)` Adds one or more values to the definitions property.
`Swagger`	`addParameters(Map<String,ParameterInfo> values)` Adds one or more values to the parameters property.
`Swagger`	`addPaths(Map<String,Map<String,Operation>> values)` Adds one or more values to the produces property.
`Swagger`	`addProduces(Collection<MediaType> values)` Adds one or more values to the produces property.
`Swagger`	`addResponses(Map<String,ResponseInfo> values)` Adds one or more values to the responses property.
`Swagger`	`addSchemes(Collection<String> values)` Adds one or more values to the schemes property.
`Swagger`	`addSecurity(Collection<Map<String,List<String>>> values)` Adds one or more values to the security property.
`Swagger`	`addSecurityDefinitions(Map<String,SecurityScheme> values)` Adds one or more values to the securityDefinitions property.
`Swagger`	`addTags(Collection<Tag> values)` Adds one or more values to the security property.
`Swagger`	`basePath(Object value)` Same as `setBasePath(String)`.
`Swagger`	`consumes(Object... values)` Adds one or more values to the consumes property.
`Swagger`	`definition(String name, SchemaInfo schema)` Adds a single value to the definitions property.
`Swagger`	`definitions(Object... values)` Adds one or more values to the definitions property.
`Swagger`	`externalDocs(Object value)` Same as `setExternalDocs(ExternalDocumentation)`.
`<T> T`	`get(String property, Class<T> type)` Generic property getter.
`String`	`getBasePath()` Bean property getter: basePath.
`List<MediaType>`	`getConsumes()` Bean property getter: consumes.
`Map<String,SchemaInfo>`	`getDefinitions()` Bean property getter: definitions.
`ExternalDocumentation`	`getExternalDocs()` Bean property getter: externalDocs.
`String`	`getHost()` Bean property getter: host.
`Info`	`getInfo()` Bean property getter: info.
`Map<String,ParameterInfo>`	`getParameters()` Bean property getter: parameters.
`Map<String,Map<String,Operation>>`	`getPaths()` Bean property getter: paths.
`List<MediaType>`	`getProduces()` Bean property getter: produces.
`Map<String,ResponseInfo>`	`getResponses()` Bean property getter: responses.
`List<String>`	`getSchemes()` Bean property getter: schemes.
`List<Map<String,List<String>>>`	`getSecurity()` Bean property getter: security.
`Map<String,SecurityScheme>`	`getSecurityDefinitions()` Bean property getter: securityDefinitions.
`String`	`getSwagger()` Bean property getter: swagger.
`List<Tag>`	`getTags()` Bean property getter: tags.
`Swagger`	`host(Object value)` Same as `setHost(String)`.
`Swagger`	`info(Object value)` Same as `setInfo(Info)`.
`Swagger`	`parameter(String name, ParameterInfo parameter)` Adds a single value to the parameter property.
`Swagger`	`parameters(Object... values)` Adds one or more values to the properties property.
`Swagger`	`path(String path, String methodName, Operation operation)` Adds a single value to the paths property.
`Swagger`	`paths(Object... values)` Adds one or more values to the paths property.
`Swagger`	`produces(Object... values)` Adds one or more values to the produces property.
`Swagger`	`response(String name, ResponseInfo response)` Adds a single value to the responses property.
`Swagger`	`responses(Object... values)` Adds one or more values to the properties property.
`Swagger`	`schemes(Object... values)` Same as `addSchemes(Collection)`.
`Swagger`	`securities(Object... values)` Adds one or more values to the securityDefinitions property.
`Swagger`	`security(String scheme, String... alternatives)` Adds a single value to the securityDefinitions property.
`Swagger`	`securityDefinition(String name, SecurityScheme securityScheme)` Adds a single value to the securityDefinitions property.
`Swagger`	`securityDefinitions(Object... values)` Adds one or more values to the securityDefinitions property.
`Swagger`	`set(String property, Object value)` Generic property setter.
`Swagger`	`setBasePath(String value)` Bean property setter: basePath.
`Swagger`	`setConsumes(Collection<MediaType> value)` Bean property setter: consumes.
`Swagger`	`setDefinitions(Map<String,SchemaInfo> value)` Bean property setter: definitions.
`Swagger`	`setExternalDocs(ExternalDocumentation value)` Bean property setter: externalDocs.
`Swagger`	`setHost(String value)` Bean property setter: host.
`Swagger`	`setInfo(Info value)` Bean property setter: info.
`Swagger`	`setParameters(Map<String,ParameterInfo> value)` Bean property setter: parameters.
`Swagger`	`setPaths(Map<String,Map<String,Operation>> value)` Bean property setter: paths.
`Swagger`	`setProduces(Collection<MediaType> value)` Bean property setter: produces.
`Swagger`	`setResponses(Map<String,ResponseInfo> value)` Bean property setter: responses.
`Swagger`	`setSchemes(Collection<String> value)` Bean property setter: schemes.
`Swagger`	`setSecurity(Collection<Map<String,List<String>>> value)` Bean property setter: security.
`Swagger`	`setSecurityDefinitions(Map<String,SecurityScheme> value)` Bean property setter: securityDefinitions.
`Swagger`	`setSwagger(String value)` Bean property setter: swagger.
`Swagger`	`setTags(Collection<Tag> value)` Bean property setter: tags.
`Swagger`	`swagger(Object value)` Same as `setSwagger(String)`.
`Swagger`	`tags(Object... values)` Adds one or more values to the tags property.
`String`	`toString()`

Methods inherited from class org.apache.juneau.dto.swagger.SwaggerElement
getExtraProperties, isStrict, strict, strict

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - NULL
```
public static final Swagger NULL
```
    Represents a null swagger
- Constructor Detail
  - Swagger
```
public Swagger()
```
- Method Detail
  - getSwagger
```
public String getSwagger()
```
    Bean property getter: swagger.
    Specifies the Swagger Specification version being used.
    It can be used by the Swagger UI and other clients to interpret the API listing.
    
    Returns:
    
    The property value, or null if it is not set.
  - setSwagger
```
public Swagger setSwagger(String value)
```
    Bean property setter: swagger.
    Specifies the Swagger Specification version being used.
    It can be used by the Swagger UI and other clients to interpret the API listing.
    
    Parameters:
    
    value - The new value for this property.
    Property value is required.
    
    Returns:
    
    This object (for method chaining).
  - swagger
```
public Swagger swagger(Object value)
```
    Same as setSwagger(String).
    
    Parameters:
    
    value - The new value for this property.
    Non-String values will be converted to String using toString().
    Can be null to unset the property.
    
    Returns:
    
    This object (for method chaining).
  - getInfo
```
public Info getInfo()
```
    Bean property getter: info.
    Provides metadata about the API.
    The metadata can be used by the clients if needed.
    
    Returns:
    
    The property value, or null if it is not set.
  - setInfo
```
public Swagger setInfo(Info value)
```
    Bean property setter: info.
    Provides metadata about the API.
    The metadata can be used by the clients if needed.
    
    Parameters:
    
    value - The new value for this property.
    Property value is required.
    
    Returns:
    
    This object (for method chaining).
  - info
```
public Swagger info(Object value)
```
    Same as setInfo(Info).
    Parameters:
    value - The new value for this property.
    Valid types:
    
    Info
    String - JSON object representation of Info
    Example:
    
    info("{title:'title',description:'description',...}");
    
    Property value is required.
    Returns:
    
    This object (for method chaining).
  - getHost
```
public String getHost()
```
    Bean property getter: host.
    The host (name or IP) serving the API.
    
    Returns:
    
    The property value, or null if it is not set.
  - setHost
```
public Swagger setHost(String value)
```
    Bean property setter: host.
    The host (name or IP) serving the API.
    
    Parameters:
    
    value - The new value for this property.
    This MUST be the host only and does not include the scheme nor sub-paths.
    It MAY include a port.
    If the host is not included, the host serving the documentation is to be used (including the port).
    The host does not support path templating
    Can be null to unset the property.
    
    Returns:
    
    This object (for method chaining).
  - host
```
public Swagger host(Object value)
```
    Same as setHost(String).
    
    Parameters:
    
    value - The new value for this property.
    Non-String values will be converted to String using toString().
    This MUST be the host only and does not include the scheme nor sub-paths.
    It MAY include a port.
    If the host is not included, the host serving the documentation is to be used (including the port).
    The host does not support path templating
    Can be null to unset the property.
    
    Returns:
    
    This object (for method chaining).
  - getBasePath
```
public String getBasePath()
```
    Bean property getter: basePath.
    The base path on which the API is served, which is relative to the host.
    
    Returns:
    
    The property value, or null if it is not set.
  - setBasePath
```
public Swagger setBasePath(String value)
```
    Bean property setter: basePath.
    The base path on which the API is served, which is relative to the host.
    
    Parameters:
    
    value - The new value for this property.
    If it is not included, the API is served directly under the host.
    The value MUST start with a leading slash (/).
    The basePath does not support path templating.
    Can be null to unset the property.
    
    Returns:
    
    This object (for method chaining).
  - basePath
```
public Swagger basePath(Object value)
```
    Same as setBasePath(String).
    
    Parameters:
    
    value - The new value for this property.
    Non-String values will be converted to String using toString().
    If it is not included, the API is served directly under the host.
    The value MUST start with a leading slash (/).
    The basePath does not support path templating.
    Can be null to unset the property.
    
    Returns:
    
    This object (for method chaining).
  - getSchemes
```
public List<String> getSchemes()
```
    Bean property getter: schemes.
    The transfer protocol of the API.
    If the schemes is not included, the default scheme to be used is the one used to access the Swagger definition itself.
    
    Returns:
    
    The property value, or null if it is not set.
  - setSchemes
```
public Swagger setSchemes(Collection<String> value)
```
    Bean property setter: schemes.
    The transfer protocol of the API.
    If the schemes is not included, the default scheme to be used is the one used to access the Swagger definition itself.
    Parameters:
    value - The new value for this property.
    Valid values:
    
    "http"
    "https"
    "ws"
    "wss"
    
    Can be null to unset the property.
    Returns:
    
    This object (for method chaining).
  - addSchemes
```
public Swagger addSchemes(Collection<String> values)
```
    Adds one or more values to the schemes property.
    The transfer protocol of the API.
    Values MUST be from the list: "http", "https", "ws", "wss". If the schemes is not included, the default scheme to be used is the one used to access the Swagger definition itself.
    Parameters:
    values - The values to add to this property.
    Valid values:
    
    "http"
    "https"
    "ws"
    "wss"
    
    Ignored if null.
    Returns:
    
    This object (for method chaining).
  - schemes
```
public Swagger schemes(Object... values)
```
    Same as addSchemes(Collection).
    Parameters:
    values - The values to add to this property.
    Valid types:
    
    Collection<String>
    String - JSON array representation of Collection<String>
    Example:
    
    schemes("['scheme1','scheme2']");
    
    String - Individual values
    Example:
    
    schemes("scheme1", "scheme2");
    Returns:
    
    This object (for method chaining).
  - getConsumes
```
public List<MediaType> getConsumes()
```
    Bean property getter: consumes.
    A list of MIME types the APIs can consume.
    This is global to all APIs but can be overridden on specific API calls.
    
    Returns:
    
    The property value, or null if it is not set.
  - setConsumes
```
public Swagger setConsumes(Collection<MediaType> value)
```
    Bean property setter: consumes.
    A list of MIME types the APIs can consume.
    This is global to all APIs but can be overridden on specific API calls.
    
    Parameters:
    
    value - The new value for this property.
    Value MUST be as described under Mime Types.
    Can be null to unset the property.
    
    Returns:
    
    This object (for method chaining).
  - addConsumes
```
public Swagger addConsumes(Collection<MediaType> values)
```
    Adds one or more values to the consumes property.
    A list of MIME types the operation can consume. This overrides the consumes definition at the Swagger Object. An empty value MAY be used to clear the global definition. Value MUST be as described under Mime Types.
    
    Parameters:
    
    values - The values to add to this property.
    Values MUST be as described under Mime Types.
    Ignored if null.
    
    Returns:
    
    This object (for method chaining).
  - consumes
```
public Swagger consumes(Object... values)
```
    Adds one or more values to the consumes property.
    Parameters:
    values - The values to add to this property.
    Valid types:
    
    MediaType
    Collection<MediaType|String>
    String - JSON array representation of Collection<MediaType>
    Example:
    
    consumes("['text/json']");
    
    String - Individual values
    Example:
    
    consumes("text/json");
    
    Ignored if null.
    Returns:
    
    This object (for method chaining).
  - getProduces
```
public List<MediaType> getProduces()
```
    Bean property getter: produces.
    A list of MIME types the APIs can produce.
    This is global to all APIs but can be overridden on specific API calls.
    
    Returns:
    
    The property value, or null if it is not set.
  - setProduces
```
public Swagger setProduces(Collection<MediaType> value)
```
    Bean property setter: produces.
    A list of MIME types the APIs can produce.
    This is global to all APIs but can be overridden on specific API calls.
    
    Parameters:
    
    value - The new value for this property.
    Value MUST be as described under Mime Types.
    Can be null to unset the property.
    
    Returns:
    
    This object (for method chaining).
  - addProduces
```
public Swagger addProduces(Collection<MediaType> values)
```
    Adds one or more values to the produces property.
    A list of MIME types the APIs can produce.
    This is global to all APIs but can be overridden on specific API calls.
    
    Parameters:
    
    values - The values to add to this property.
    Value MUST be as described under Mime Types.
    Can be null to unset the property.
    
    Returns:
    
    This object (for method chaining).
  - produces
```
public Swagger produces(Object... values)
```
    Adds one or more values to the produces property.
    Parameters:
    values - The values to add to this property.
    Valid types:
    
    MediaType
    Collection<MediaType|String>
    String - JSON array representation of Collection<MediaType>
    Example:
    
    consumes("['text/json']");
    
    String - Individual values
    Example:
    
    consumes("text/json");
    
    Ignored if null.
    Returns:
    
    This object (for method chaining).
  - getPaths
```
public Map<String,Map<String,Operation>> getPaths()
```
    Bean property getter: paths.
    The available paths and operations for the API.
    
    Returns:
    
    The property value, or null if it is not set.
  - setPaths
```
public Swagger setPaths(Map<String,Map<String,Operation>> value)
```
    Bean property setter: paths.
    The available paths and operations for the API.
    
    Parameters:
    
    value - The new value for this property.
    Property value is required.
    
    Returns:
    
    This object (for method chaining).
  - addPaths
```
public Swagger addPaths(Map<String,Map<String,Operation>> values)
```
    Adds one or more values to the produces property.
    A list of MIME types the APIs can produce.
    This is global to all APIs but can be overridden on specific API calls.
    
    Parameters:
    
    values - The values to add to this property.
    Ignored if null.
    
    Returns:
    
    This object (for method chaining).
  - path
```
public Swagger path(String path,
                    String methodName,
                    Operation operation)
```
    Adds a single value to the paths property.
    
    Parameters:
    
    path - The path template.
    
    methodName - The HTTP method name.
    
    operation - The operation that describes the path.
    
    Returns:
    
    This object (for method chaining).
  - paths
```
public Swagger paths(Object... values)
```
    Adds one or more values to the paths property.
    Parameters:
    values - The values to add to this property.
    Valid types:
    
    Map<String,Map<String,Operation>|String>
    String - JSON object representation of Map<String,Map<String,Operation>>
    Example:
    
    paths("{'foo':{'get':{operationId:'operationId',...}}}");
    
    Ignored if null.
    Returns:
    
    This object (for method chaining).
  - getDefinitions
```
public Map<String,SchemaInfo> getDefinitions()
```
    Bean property getter: definitions.
    An object to hold data types produced and consumed by operations.
    
    Returns:
    
    The property value, or null if it is not set.
  - setDefinitions
```
public Swagger setDefinitions(Map<String,SchemaInfo> value)
```
    Bean property setter: definitions.
    An object to hold data types produced and consumed by operations.
    
    Parameters:
    
    value - The new value for this property.
    Can be null to unset the property.
    
    Returns:
    
    This object (for method chaining).
  - addDefinitions
```
public Swagger addDefinitions(Map<String,SchemaInfo> values)
```
    Adds one or more values to the definitions property.
    An object to hold data types produced and consumed by operations.
    
    Parameters:
    
    values - The values to add to this property.
    Ignored if null.
    
    Returns:
    
    This object (for method chaining).
  - definition
```
public Swagger definition(String name,
                          SchemaInfo schema)
```
    Adds a single value to the definitions property.
    
    Parameters:
    
    name - A definition name.
    
    schema - The schema that the name defines.
    
    Returns:
    
    This object (for method chaining).
  - definitions
```
public Swagger definitions(Object... values)
```
    Adds one or more values to the definitions property.
    Parameters:
    values - The values to add to this property.
    Valid types:
    
    Map<String,Map<String,SchemaInfo>|String>
    String - JSON object representation of Map<String,Map<String,SchemaInfo>>
    Example:
    
    definitions("{'foo':{'bar':{format:'format',...}}}");
    
    Ignored if null.
    Returns:
    
    This object (for method chaining).
  - getParameters
```
public Map<String,ParameterInfo> getParameters()
```
    Bean property getter: parameters.
    An object to hold parameters that can be used across operations.
    This property does not define global parameters for all operations.
    
    Returns:
    
    The property value, or null if it is not set.
  - setParameters
```
public Swagger setParameters(Map<String,ParameterInfo> value)
```
    Bean property setter: parameters.
    An object to hold parameters that can be used across operations.
    This property does not define global parameters for all operations.
    
    Parameters:
    
    value - The new value for this property.
    Can be null to unset the property.
    
    Returns:
    
    This object (for method chaining).
  - addParameters
```
public Swagger addParameters(Map<String,ParameterInfo> values)
```
    Adds one or more values to the parameters property.
    An object to hold parameters that can be used across operations.
    This property does not define global parameters for all operations.
    
    Parameters:
    
    values - The values to add to this property.
    Ignored if null.
    
    Returns:
    
    This object (for method chaining).
  - parameter
```
public Swagger parameter(String name,
                         ParameterInfo parameter)
```
    Adds a single value to the parameter property.
    
    Parameters:
    
    name - The parameter name.
    
    parameter - The parameter definition.
    
    Returns:
    
    This object (for method chaining).
  - parameters
```
public Swagger parameters(Object... values)
```
    Adds one or more values to the properties property.
    Parameters:
    values - The values to add to this property.
    Valid types:
    
    Map<String,ParameterInfo|String>
    String - JSON object representation of Map<String,ParameterInfo>
    Example:
    
    parameters("{'foo':{name:'name',...}}");
    
    Ignored if null.
    Returns:
    
    This object (for method chaining).
  - getResponses
```
public Map<String,ResponseInfo> getResponses()
```
    Bean property getter: responses.
    An object to hold responses that can be used across operations.
    This property does not define global responses for all operations.
    
    Returns:
    
    The property value, or null if it is not set.
  - setResponses
```
public Swagger setResponses(Map<String,ResponseInfo> value)
```
    Bean property setter: responses.
    An object to hold responses that can be used across operations.
    This property does not define global responses for all operations.
    
    Parameters:
    
    value - The new value for this property.
    Can be null to unset the property.
    
    Returns:
    
    This object (for method chaining).
  - addResponses
```
public Swagger addResponses(Map<String,ResponseInfo> values)
```
    Adds one or more values to the responses property.
    An object to hold responses that can be used across operations.
    This property does not define global responses for all operations.
    
    Parameters:
    
    values - The values to add to this property.
    Ignored if null.
    
    Returns:
    
    This object (for method chaining).
  - response
```
public Swagger response(String name,
                        ResponseInfo response)
```
    Adds a single value to the responses property.
    
    Parameters:
    
    name - The response name.
    
    response - The response definition.
    
    Returns:
    
    This object (for method chaining).
  - responses
```
public Swagger responses(Object... values)
```
    Adds one or more values to the properties property.
    Parameters:
    values - The values to add to this property.
    Valid types:
    
    Map<String,ResponseInfo|String>
    String - JSON object representation of Map<String,ResponseInfo>
    Example:
    
    responses("{'foo':{description:'description',...}}");
    
    Ignored if null.
    Returns:
    
    This object (for method chaining).
  - getSecurityDefinitions
```
public Map<String,SecurityScheme> getSecurityDefinitions()
```
    Bean property getter: securityDefinitions.
    Security scheme definitions that can be used across the specification.
    
    Returns:
    
    The property value, or null if it is not set.
  - setSecurityDefinitions
```
public Swagger setSecurityDefinitions(Map<String,SecurityScheme> value)
```
    Bean property setter: securityDefinitions.
    Security scheme definitions that can be used across the specification.
    
    Parameters:
    
    value - The new value for this property.
    Can be null to unset the property.
    
    Returns:
    
    This object (for method chaining).
  - addSecurityDefinitions
```
public Swagger addSecurityDefinitions(Map<String,SecurityScheme> values)
```
    Adds one or more values to the securityDefinitions property.
    Security scheme definitions that can be used across the specification.
    
    Parameters:
    
    values - The values to add to this property.
    Ignored if null.
    
    Returns:
    
    This object (for method chaining).
  - securityDefinition
```
public Swagger securityDefinition(String name,
                                  SecurityScheme securityScheme)
```
    Adds a single value to the securityDefinitions property.
    
    Parameters:
    
    name - A security name.
    
    securityScheme - A security schema.
    
    Returns:
    
    This object (for method chaining).
  - securityDefinitions
```
public Swagger securityDefinitions(Object... values)
```
    Adds one or more values to the securityDefinitions property.
    Parameters:
    values - The values to add to this property.
    Valid types:
    
    Map<String,SecurityScheme|String>
    String - JSON object representation of Map<String,SecurityScheme>
    Example:
    
    securityDefinitions("{'foo':{name:'name',...}}");
    
    Ignored if null.
    Returns:
    
    This object (for method chaining).
  - getSecurity
```
public List<Map<String,List<String>>> getSecurity()
```
    Bean property getter: security.
    A declaration of which security schemes are applied for the API as a whole.
    The list of values describes alternative security schemes that can be used (that is, there is a logical OR between the security requirements).
    Individual operations can override this definition.
    
    Returns:
    
    The property value, or null if it is not set.
  - setSecurity
```
public Swagger setSecurity(Collection<Map<String,List<String>>> value)
```
    Bean property setter: security.
    A declaration of which security schemes are applied for the API as a whole.
    The list of values describes alternative security schemes that can be used (that is, there is a logical OR between the security requirements).
    Individual operations can override this definition.
    
    Parameters:
    
    value - The new value for this property.
    Can be null to unset the property.
    
    Returns:
    
    This object (for method chaining).
  - addSecurity
```
public Swagger addSecurity(Collection<Map<String,List<String>>> values)
```
    Adds one or more values to the security property.
    A declaration of which security schemes are applied for the API as a whole.
    The list of values describes alternative security schemes that can be used (that is, there is a logical OR between the security requirements).
    Individual operations can override this definition.
    
    Parameters:
    
    values - The values to add to this property.
    Ignored if null.
    
    Returns:
    
    This object (for method chaining).
  - security
```
public Swagger security(String scheme,
                        String... alternatives)
```
    Adds a single value to the securityDefinitions property.
    
    Parameters:
    
    scheme - The security scheme that applies to this operation
    
    alternatives - The list of values describes alternative security schemes that can be used (that is, there is a logical OR between the security requirements).
    
    Returns:
    
    This object (for method chaining).
  - securities
```
public Swagger securities(Object... values)
```
    Adds one or more values to the securityDefinitions property.
    Parameters:
    values - The values to add to this property.
    Valid types:
    
    Collection<Map<String,List<String>>>
    String - JSON array representation of Collection<Map<String,List<String>>>
    Example:
    
    securities("[{...}]");
    
    String - JSON object representation of Map<String,List<String>>
    Example:
    
    securities("{...}");
    
    Ignored if null.
    Returns:
    
    This object (for method chaining).
  - getTags
```
public List<Tag> getTags()
```
    Bean property getter: tags.
    A list of tags used by the specification with additional metadata.
    
    Returns:
    
    The property value, or null if it is not set.
  - setTags
```
public Swagger setTags(Collection<Tag> value)
```
    Bean property setter: tags.
    A list of tags used by the specification with additional metadata.
    
    Parameters:
    
    value - The new value for this property.
    The order of the tags can be used to reflect on their order by the parsing tools.
    Not all tags that are used by the Operation Object must be declared.
    The tags that are not declared may be organized randomly or based on the tools' logic.
    Each tag name in the list MUST be unique.
    Can be null to unset the property.
    
    Returns:
    
    This object (for method chaining).
  - addTags
```
public Swagger addTags(Collection<Tag> values)
```
    Adds one or more values to the security property.
    A list of tags used by the specification with additional metadata.
    
    Parameters:
    
    values - The values to add to this property.
    The order of the tags can be used to reflect on their order by the parsing tools.
    Not all tags that are used by the Operation Object must be declared.
    The tags that are not declared may be organized randomly or based on the tools' logic.
    Each tag name in the list MUST be unique.
    Ignored if null.
    
    Returns:
    
    This object (for method chaining).
  - tags
```
public Swagger tags(Object... values)
```
    Adds one or more values to the tags property.
    Parameters:
    values - The values to add to this property.
    Valid types:
    
    Tag
    Collection<Tag|String>
    Tag[]
    String - JSON array representation of Collection<Tag>
    Example:
    
    tags("[{name:'name',description:'description',...}]");
    
    String - JSON object representation of Tag
    Example:
    
    tags("{name:'name',description:'description',...}");
    
    Ignored if null.
    Returns:
    
    This object (for method chaining).
  - getExternalDocs
```
public ExternalDocumentation getExternalDocs()
```
    Bean property getter: externalDocs.
    Additional external documentation.
    
    Returns:
    
    The property value, or null if it is not set.
  - setExternalDocs
```
public Swagger setExternalDocs(ExternalDocumentation value)
```
    Bean property setter: externalDocs.
    Additional external documentation.
    
    Parameters:
    
    value - The new value for this property.
    Can be null to unset the property.
    
    Returns:
    
    This object (for method chaining).
  - externalDocs
```
public Swagger externalDocs(Object value)
```
    Same as setExternalDocs(ExternalDocumentation).
    Parameters:
    value - The new value for this property.
    Valid types:
    
    ExternalDocumentation
    String - JSON object representation of ExternalDocumentation
    Example:
    
    externalDocs("{description:'description',url:'url'}");
    
    Can be null to unset the property.
    Returns:
    
    This object (for method chaining).
  - get
```
public <T> T get(String property,
                 Class<T> type)
```
    Description copied from class: SwaggerElement
    
    Generic property getter.
    Can be used to retrieve non-standard Swagger fields such as "$ref".
    
    Overrides:
    
    get in class SwaggerElement
    
    Parameters:
    
    property - The property name to retrieve.
    
    type - The datatype to cast the value to.
    
    Returns:
    
    The property value, or null if the property does not exist or is not set.
  - set
```
public Swagger set(String property,
                   Object value)
```
    Description copied from class: SwaggerElement
    
    Generic property setter.
    Can be used to set non-standard Swagger fields such as "$ref".
    
    Overrides:
    
    set in class SwaggerElement
    
    Parameters:
    
    property - The property name to set.
    
    value - The new value for the property.
    
    Returns:
    
    This object (for method chaining).
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class SwaggerElement

Class Swagger

See Also:

Field Summary

Constructor Summary

Method Summary

Methods inherited from class org.apache.juneau.dto.swagger.SwaggerElement

Methods inherited from class java.lang.Object

Field Detail

NULL

Constructor Detail

Swagger

Method Detail

getSwagger

setSwagger

swagger

getInfo

setInfo

info

Example:

getHost

setHost

host

getBasePath

setBasePath

basePath

getSchemes

setSchemes

addSchemes

schemes

Example:

Example:

getConsumes

setConsumes

addConsumes

consumes

Example:

Example:

getProduces

setProduces

addProduces

produces

Example:

Example:

getPaths

setPaths

addPaths

path

paths

Example:

getDefinitions

setDefinitions

addDefinitions

definition

definitions

Example:

getParameters

setParameters

addParameters

parameter

parameters

Example:

getResponses

setResponses

addResponses

response

responses

Example:

getSecurityDefinitions

setSecurityDefinitions

addSecurityDefinitions

securityDefinition

securityDefinitions

Example:

getSecurity

setSecurity

addSecurity

security

securities

Example:

Example: