Uses of Class
org.apache.juneau.bean.swagger.Swagger

Packages that use Swagger

Package	Description
org.apache.juneau.bean.swagger	Swagger Data Transfer Objects
org.apache.juneau.bean.swagger.ui	Swagger UI Generator
org.apache.juneau.rest.server	REST Server API
org.apache.juneau.rest.server.docs	API-docs mixin pack — composable @Rest(mixins=...) resources that publish Swagger v2 and OpenAPI 3.1 spec endpoints with Swagger-UI and Redoc HTML mounts.
org.apache.juneau.rest.server.swagger	REST Swagger Support

Uses of Swagger in org.apache.juneau.bean.swagger

Fields in org.apache.juneau.bean.swagger declared as Swagger

Modifier and Type	Field	Description
static final Swagger	Swagger.NULL	Represents a null swagger

Methods in org.apache.juneau.bean.swagger that return Swagger

Modifier and Type	Method	Description
Swagger	Swagger.addConsumes(Collection<MediaType> values)	Bean property appender: consumes.
Swagger	Swagger.addConsumes(MediaType... values)	Bean property appender: consumes.
Swagger	Swagger.addDefinition(String name, JsonMap schema)	Bean property appender: definitions.
Swagger	Swagger.addOperation(String path, String method, Operation operation)	Bean property appender: paths.
Swagger	Swagger.addParameter(String name, ParameterInfo parameter)	Bean property appender: parameters.
Swagger	Swagger.addPath(String path, String methodName, Operation operation)	Bean property appender: paths.
Swagger	Swagger.addProduces(Collection<MediaType> values)	Bean property appender: produces.
Swagger	Swagger.addProduces(MediaType... values)	Adds one or more values to the produces property.
Swagger	Swagger.addResponse(String name, ResponseInfo response)	Bean property appender: responses.
Swagger	Swagger.addSchemes(String... values)	Bean property appender: schemes.
Swagger	Swagger.addSchemes(Collection<String> values)	Bean property appender: schemes.
Swagger	Swagger.addSecurity(String scheme, String... alternatives)	Bean property appender: security.
Swagger	Swagger.addSecurity(Collection<Map<String,List<String>>> values)	Bean property fluent setter: security.
Swagger	Swagger.addSecurityDefinition(String name, SecurityScheme securityScheme)	Bean property appender: securityDefinitions.
Swagger	Swagger.addTags(Collection<Tag> values)	Bean property appender: tags.
Swagger	Swagger.addTags(Tag... values)	Bean property appender: tags.
Swagger	Swagger.copy()	Make a deep copy of this object.
Swagger	Swagger.set(String property, Object value)
Swagger	Swagger.setBasePath(String value)	Bean property setter: basePath.
Swagger	Swagger.setConsumes(Collection<MediaType> value)	Bean property setter: consumes.
Swagger	Swagger.setConsumes(MediaType... value)	Bean property fluent setter: consumes.
Swagger	Swagger.setDefinitions(Map<String,JsonMap> value)	Bean property setter: definitions.
Swagger	Swagger.setExternalDocs(ExternalDocumentation value)	Bean property setter: externalDocs.
Swagger	Swagger.setHost(String value)	Bean property setter: host.
Swagger	Swagger.setInfo(Info value)	Bean property setter: info.
Swagger	Swagger.setParameters(Map<String,ParameterInfo> value)	Bean property setter: parameters.
Swagger	Swagger.setPaths(Map<String,OperationMap> value)	Bean property setter: paths.
Swagger	Swagger.setProduces(Collection<MediaType> value)	Bean property setter: produces.
Swagger	Swagger.setProduces(MediaType... value)	Bean property fluent setter: produces.
Swagger	Swagger.setResponses(Map<String,ResponseInfo> value)	Bean property setter: responses.
Swagger	Swagger.setSchemes(String... value)	Bean property fluent setter: schemes.
Swagger	Swagger.setSchemes(Collection<String> value)	Bean property setter: schemes.
Swagger	Swagger.setSecurity(Collection<Map<String,List<String>>> value)	Bean property setter: security.
Swagger	Swagger.setSecurityDefinitions(Map<String,SecurityScheme> value)	Bean property setter: securityDefinitions.
Swagger	Swagger.setSwagger(String value)	Bean property setter: swagger.
Swagger	Swagger.setTags(Collection<Tag> value)	Bean property setter: tags.
Swagger	Swagger.setTags(Tag... value)	Bean property setter: tags.
Swagger	Swagger.strict()	Sets strict mode on this bean.
Swagger	Swagger.strict(Object value)	Sets strict mode on this bean.
static final Swagger	SwaggerBuilder.swagger()	Creates an empty Swagger element.
static final Swagger	SwaggerBuilder.swagger(Info info)	Creates an Swagger element with the specified info attribute.

Methods in org.apache.juneau.bean.swagger with parameters of type Swagger

Modifier and Type	Method	Description
HeaderInfo	HeaderInfo.resolveRefs(Swagger swagger, Deque<String> refStack, int maxDepth)	Resolves any "$ref" attributes in this element.
Items	Items.resolveRefs(Swagger swagger, Deque<String> refStack, int maxDepth)	Resolves any "$ref" attributes in this element.
ParameterInfo	ParameterInfo.resolveRefs(Swagger swagger, Deque<String> refStack, int maxDepth)	Resolves any "$ref" attributes in this element.
ResponseInfo	ResponseInfo.resolveRefs(Swagger swagger, Deque<String> refStack, int maxDepth)	Resolves any "$ref" attributes in this element.
SchemaInfo	SchemaInfo.resolveRefs(Swagger swagger, Deque<String> refStack, int maxDepth)	Resolves any "$ref" attributes in this element.

Constructors in org.apache.juneau.bean.swagger with parameters of type Swagger

Modifier	Constructor	Description
	Swagger(Swagger copyFrom)	Copy constructor.

Uses of Swagger in org.apache.juneau.bean.swagger.ui

Methods in org.apache.juneau.bean.swagger.ui with parameters of type Swagger

Modifier and Type	Method	Description
Div	SwaggerUI.swap(MarshallingSession marshallingSession, Swagger swagger)

Uses of Swagger in org.apache.juneau.rest.server

Fields in org.apache.juneau.rest.server with type parameters of type Swagger

Modifier and Type	Field	Description
protected final ConcurrentHashMap<Locale,Swagger>	RestContext.swaggerCache

Methods in org.apache.juneau.rest.server that return types with arguments of type Swagger

Modifier and Type	Method	Description
Optional<Swagger>	RestContext.getSwagger(Locale locale)	Returns the swagger for the REST resource.
Optional<Swagger>	RestRequest.getSwagger()	Returns the localized swagger associated with the resource.

Uses of Swagger in org.apache.juneau.rest.server.docs

Methods in org.apache.juneau.rest.server.docs that return Swagger

Modifier and Type	Method	Description
Swagger	SwaggerMixin.getSwagger(RestRequest req)	[GET /api] — emit the Swagger v2 spec for this resource.
Swagger	SwaggerUiMixin.getSwaggerUi(RestRequest req)	[GET /swagger] — render the Swagger-UI HTML view (or the spec, depending on Accept).

Uses of Swagger in org.apache.juneau.rest.server.swagger

Methods in org.apache.juneau.rest.server.swagger that return Swagger

Modifier and Type	Method	Description
Swagger	BasicSwaggerProvider.getSwagger(RestContext context, Locale locale)	Returns the Swagger associated with the specified context of a Rest-annotated class.
Swagger	BasicSwaggerProviderSession.getSwagger()	Generates the swagger.
Swagger	SwaggerProvider.getSwagger(RestContext context, Locale locale)	Returns the Swagger associated with the specified Rest-annotated class.