public @interface MethodSwagger
Modifier and Type | Optional Element and Description |
---|---|
String[] |
consumes
Defines the swagger field
/paths/{path}/{method}/consumes . |
String |
deprecated
Defines the swagger field
/paths/{path}/{method}/deprecated . |
String[] |
description
Defines the swagger field
/paths/{path}/{method}/description . |
ExternalDocs |
externalDocs
Defines the swagger field
/paths/{path}/{method}/externalDocs . |
String |
operationId
Defines the swagger field
/paths/{path}/{method}/operationId . |
String[] |
parameters
Defines the swagger field
/paths/{path}/{method}/parameters . |
String[] |
produces
Defines the swagger field
/paths/{path}/{method}/consumes . |
String[] |
responses
Defines the swagger field
/paths/{path}/{method}/responses . |
String[] |
schemes
Defines the swagger field
/paths/{path}/{method}/schemes . |
String[] |
summary
Defines the swagger field
/paths/{path}/{method}/summary . |
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
/paths/{path}/{method}/summary
.
RestMethod.summary()
.
public abstract String[] description
/paths/{path}/{method}/description
.
RestMethod.description()
.
public abstract String operationId
/paths/{path}/{method}/operationId
.
public abstract String[] schemes
/paths/{path}/{method}/schemes
.
public abstract String deprecated
/paths/{path}/{method}/deprecated
.
@Deprecated
public abstract String[] consumes
/paths/{path}/{method}/consumes
.
Use this value to override the supported Content-Type
media types defined by the parsers defined via RestMethod.parsers()
.
public abstract String[] produces
/paths/{path}/{method}/consumes
.
Use this value to override the supported Accept
media types defined by the serializers defined via RestMethod.serializers()
.
public abstract ExternalDocs externalDocs
/paths/{path}/{method}/externalDocs
.
public abstract String[] parameters
/paths/{path}/{method}/parameters
.
This annotation is provided for documentation purposes and is used to populate the method
public abstract String[] responses
/paths/{path}/{method}/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.
/paths/{path}/{method}/tags
.
public abstract String[] value
This is a Overview > juneau-marshall > JSON Details > Simplified 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:
{ }
characters are optional.
Copyright © 2018 Apache. All rights reserved.