@Target(value=TYPE)
@Retention(value=RUNTIME)
@Inherited
public @interface SwaggerDefinition
Modifier and Type | Optional Element and Description |
---|---|
java.lang.String |
basePath
The basePath to specify in the generated Swagger definition.
|
java.lang.String[] |
consumes
Global level consumes for this swagger definition.
|
ExternalDocs |
externalDocs
Reference to external documentation for this Swagger definition.
|
java.lang.String |
host
The host to specify in the generated Swagger definition.
|
Info |
info
General metadata for this Swagger definition.
|
java.lang.String[] |
produces
Global level produces for this swagger definition.
|
SwaggerDefinition.Scheme[] |
schemes
The transfer protocol of the API.
|
SecurityDefinition |
securityDefinition
Defintions for security schemes
|
Tag[] |
tags
Global tags that can be used to tag individual Apis and ApiOperations.
|
public abstract java.lang.String host
public abstract java.lang.String basePath
public abstract java.lang.String[] consumes
These will be added to all api definitions that don't have local overrides - see https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#swagger-object
public abstract java.lang.String[] produces
These will be added to all api definitions that don't have local overrides - see https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#swagger-object
public abstract SwaggerDefinition.Scheme[] schemes
Setting this to Scheme.DEFAULT will result in the result being generated from the hosting container.
public abstract Tag[] tags
See https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#tagObject
public abstract SecurityDefinition securityDefinition
public abstract Info info
See https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#infoObject
public abstract ExternalDocs externalDocs
Copyright © 2018. All Rights Reserved.