public interface SwaggerV2
| Modifier and Type | Field and Description |
|---|---|
static Class<? extends io.swagger.jaxrs.config.ReaderListener> |
CONTEXT_READER_LISTENER
A
ReaderListener class to include in the API classes to enable a consistent API definition generation
when the PropertyBox type is used. |
| Modifier and Type | Method and Description |
|---|---|
static String |
asJson(io.swagger.models.Swagger api)
Convert given API definition in JSON format.
|
static String |
asJson(io.swagger.models.Swagger api,
boolean pretty)
Convert given API definition in JSON format.
|
static String |
asYaml(io.swagger.models.Swagger api)
Convert given API definition in YAML format.
|
static String |
asYaml(io.swagger.models.Swagger api,
boolean pretty)
Convert given API definition in YAML format.
|
static ApiReader<io.swagger.models.Swagger> |
reader(io.swagger.config.SwaggerConfig configuration)
Create a new
ApiReader to create an Swagger definition from a set of API resource classes. |
static ApiReader<io.swagger.models.Swagger> |
reader(io.swagger.config.SwaggerConfig configuration,
boolean includeAll)
Create a new
ApiReader to create an Swagger definition from a set of API resource classes. |
static final Class<? extends io.swagger.jaxrs.config.ReaderListener> CONTEXT_READER_LISTENER
ReaderListener class to include in the API classes to enable a consistent API definition generation
when the PropertyBox type is used.static ApiReader<io.swagger.models.Swagger> reader(io.swagger.config.SwaggerConfig configuration)
ApiReader to create an Swagger definition from a set of API resource classes.configuration - The configuration to useApiReader instancestatic ApiReader<io.swagger.models.Swagger> reader(io.swagger.config.SwaggerConfig configuration, boolean includeAll)
ApiReader to create an Swagger definition from a set of API resource classes.configuration - The configuration to useincludeAll - Whether to include all API resource classes. If false, only the Api
annotated classes will be included in the API definitions.ApiReader instancestatic String asJson(io.swagger.models.Swagger api, boolean pretty)
api - The API model to serializepretty - Whether to pretty format the outputstatic String asJson(io.swagger.models.Swagger api)
api - The API model to serializestatic String asYaml(io.swagger.models.Swagger api, boolean pretty)
api - The API model to serializepretty - Whether to pretty format the outputstatic String asYaml(io.swagger.models.Swagger api)
api - The API model to serializeCopyright © 2019 The Holon Platform. All rights reserved.