public @interface MethodSwagger
RestMethod.swagger()
.
Modifier and Type | Optional Element and Description |
---|---|
String[] |
consumes
Defines the swagger field
|
String |
deprecated
Defines the swagger field
|
String[] |
description
Defines the swagger field
|
ExternalDocs |
externalDocs
Defines the swagger field
|
String |
operationId
Defines the swagger field
|
String[] |
parameters
Defines the swagger field
|
String[] |
produces
Defines the swagger field
|
String[] |
responses
Defines the swagger field
|
String[] |
schemes
Defines the swagger field
|
String[] |
summary
Defines the swagger field
|
String[] |
tags
Optional tagging information for the exposed API.
|
String[] |
value
Free-form value for the swagger of a resource method.
|
public abstract String[] summary
RestMethod.summary()
.
public abstract String[] description
RestMethod.description()
.
public abstract String operationId
public abstract String[] schemes
public abstract String deprecated
@Deprecated
public abstract String[] consumes
Use this value to override the supported RestMethod.parsers()
.
public abstract String[] produces
Use this value to override the supported RestMethod.serializers()
.
public abstract ExternalDocs externalDocs
public abstract String[] parameters
This annotation is provided for documentation purposes and is used to populate the method
public abstract String[] responses
This annotation is provided for documentation purposes and is used to populate the method
public abstract String[] tags
Used to populate the Swagger tags field.
A comma-delimited list of tags for API documentation control.
Tags can be used for logical grouping of operations by resources or any other qualifier.
public abstract String[] value
This is a Simple JSON object that makes up the swagger information for this resource method.
The following are completely equivalent ways of defining the swagger description of a resource method:
The reasons why you may want to use this field include:
Copyright © 2016–2019 The Apache Software Foundation. All rights reserved.