org.springframework.javassist.utils

类 SwaggerApiUtils

java.lang.Object

org.springframework.javassist.utils.SwaggerApiUtils

public class SwaggerApiUtils
extends Object

https://www.cnblogs.com/sunfie/p/5154246.html

作者:

vindell

构造器概要

构造器

构造器和说明
SwaggerApiUtils()

方法概要

限定符和类型	方法和说明
static javassist.bytecode.annotation.Annotation	annotApi(javassist.bytecode.ConstPool constPool, String... tags) 构造 @Api 注解
static javassist.bytecode.annotation.Annotation	annotApiIgnore(javassist.bytecode.ConstPool constPool, String desc) 构造 @ApiIgnore 注解
static javassist.bytecode.annotation.Annotation	annotApiImplicitParams(javassist.bytecode.ConstPool constPool, MvcApiImplicitParam... apiImplicitParams) 构造 @ApiImplicitParams 注解
static javassist.bytecode.annotation.Annotation	annotApiKeyAuthDefinition(javassist.bytecode.ConstPool constPool, String name, String key, String desc, io.swagger.annotations.ApiKeyAuthDefinition.ApiKeyLocation in) 构造 @ApiKeyAuthDefinition 注解
static javassist.bytecode.annotation.Annotation	annotApiOperation(javassist.bytecode.ConstPool constPool, String value, String notes) 构造 @ApiOperation 注解
static javassist.bytecode.annotation.Annotation	annotApiOperation(javassist.bytecode.ConstPool constPool, String value, String notes, Class<?> response) 构造 @ApiOperation 注解
static javassist.bytecode.annotation.Annotation	annotApiOperation(javassist.bytecode.ConstPool constPool, String value, String notes, String[] tags, Class<?> response) 构造 @ApiOperation 注解
static javassist.bytecode.annotation.Annotation	annotApiOperation(javassist.bytecode.ConstPool constPool, String value, String notes, String[] tags, Class<?> response, String responseContainer) 构造 @ApiOperation 注解
static javassist.bytecode.annotation.Annotation	annotApiOperation(javassist.bytecode.ConstPool constPool, String value, String notes, String[] tags, Class<?> response, String responseContainer, String responseReference) 构造 @ApiOperation 注解
static javassist.bytecode.annotation.Annotation	annotApiOperation(javassist.bytecode.ConstPool constPool, String value, String notes, String[] tags, Class<?> response, String responseContainer, String responseReference, String httpMethod, String nickname, String produces, String consumes, String protocols) 构造 @ApiOperation 注解
static javassist.bytecode.annotation.Annotation	annotApiOperation(javassist.bytecode.ConstPool constPool, String value, String notes, String[] tags, Class<?> response, String responseContainer, String responseReference, String httpMethod, String nickname, String produces, String consumes, String protocols, boolean hidden, int code, boolean ignoreJsonView) 构造 @ApiOperation 注解
static javassist.bytecode.annotation.Annotation	annotApiResponses(javassist.bytecode.ConstPool constPool, MvcApiResponse... apiResponses) 构造 @ApiResponses 注解

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造器详细资料

SwaggerApiUtils

public SwaggerApiUtils()

方法详细资料

annotApi

public static javassist.bytecode.annotation.Annotation annotApi(javassist.bytecode.ConstPool constPool,
                                                                String... tags)

构造 @Api 注解

参数:

constPool - ConstPool instance

tags - 标签名称

返回:

Annotation instance

annotApiIgnore

public static javassist.bytecode.annotation.Annotation annotApiIgnore(javassist.bytecode.ConstPool constPool,
                                                                      String desc)

构造 @ApiIgnore 注解

参数:

constPool - ConstPool instance

desc - 描述标签

返回:

Annotation instance

annotApiKeyAuthDefinition

public static javassist.bytecode.annotation.Annotation annotApiKeyAuthDefinition(javassist.bytecode.ConstPool constPool,
                                                                                 String name,
                                                                                 String key,
                                                                                 String desc,
                                                                                 io.swagger.annotations.ApiKeyAuthDefinition.ApiKeyLocation in)

构造 @ApiKeyAuthDefinition 注解

参数:

constPool - ConstPool instance

name - The name of the header or query parameter to be used.

key - Key used to refer to this security definition

desc - A short description for security scheme.

in - The location of the API key. Valid values are "query" or "header"

返回:

Annotation instance

annotApiOperation

public static javassist.bytecode.annotation.Annotation annotApiOperation(javassist.bytecode.ConstPool constPool,
                                                                         String value,
                                                                         String notes)

构造 @ApiOperation 注解

参数:

constPool - ConstPool instance

value - Provides a brief description of this operation. Should be 120 characters or less for proper visibility in Swagger-UI.

notes - A verbose description of the operation.

返回:

Annotation instance

annotApiOperation

public static javassist.bytecode.annotation.Annotation annotApiOperation(javassist.bytecode.ConstPool constPool,
                                                                         String value,
                                                                         String notes,
                                                                         Class<?> response)

构造 @ApiOperation 注解

参数:

constPool - ConstPool instance

value - Provides a brief description of this operation. Should be 120 characters or less for proper visibility in Swagger-UI.

notes - A verbose description of the operation.

response - The response type of the operation. If the value used is a class representing a primitive (Integer, Long, ...) the corresponding primitive type will be used.

返回:

Annotation instance

annotApiOperation

public static javassist.bytecode.annotation.Annotation annotApiOperation(javassist.bytecode.ConstPool constPool,
                                                                         String value,
                                                                         String notes,
                                                                         String[] tags,
                                                                         Class<?> response)

构造 @ApiOperation 注解

参数:

constPool - ConstPool instance

value - Provides a brief description of this operation. Should be 120 characters or less for proper visibility in Swagger-UI.

notes - A verbose description of the operation.

tags - A list of tags for API documentation control.

response - The response type of the operation. If the value used is a class representing a primitive (Integer, Long, ...) the corresponding primitive type will be used.

返回:

Annotation instance

annotApiOperation

public static javassist.bytecode.annotation.Annotation annotApiOperation(javassist.bytecode.ConstPool constPool,
                                                                         String value,
                                                                         String notes,
                                                                         String[] tags,
                                                                         Class<?> response,
                                                                         String responseContainer)

构造 @ApiOperation 注解

参数:

constPool - ConstPool instance

value - Provides a brief description of this operation. Should be 120 characters or less for proper visibility in Swagger-UI.

notes - A verbose description of the operation.

tags - A list of tags for API documentation control.

response - The response type of the operation. If the value used is a class representing a primitive (Integer, Long, ...) the corresponding primitive type will be used.

responseContainer - Declares a container wrapping the response. Valid values are "List", "Set" or "Map". Any other value will be ignored.

返回:

Annotation instance

annotApiOperation

public static javassist.bytecode.annotation.Annotation annotApiOperation(javassist.bytecode.ConstPool constPool,
                                                                         String value,
                                                                         String notes,
                                                                         String[] tags,
                                                                         Class<?> response,
                                                                         String responseContainer,
                                                                         String responseReference)

构造 @ApiOperation 注解

参数:

constPool - ConstPool instance

value - Provides a brief description of this operation. Should be 120 characters or less for proper visibility in Swagger-UI.

notes - A verbose description of the operation.

tags - A list of tags for API documentation control.

response - The response type of the operation. If the value used is a class representing a primitive (Integer, Long, ...) the corresponding primitive type will be used.

responseContainer - Declares a container wrapping the response. Valid values are "List", "Set" or "Map". Any other value will be ignored.

responseReference - Specifies a reference to the response type. The specified reference can be either local or remote and will be used as-is, and will override any specified response() class.

返回:

Annotation instance

annotApiOperation

public static javassist.bytecode.annotation.Annotation annotApiOperation(javassist.bytecode.ConstPool constPool,
                                                                         String value,
                                                                         String notes,
                                                                         String[] tags,
                                                                         Class<?> response,
                                                                         String responseContainer,
                                                                         String responseReference,
                                                                         String httpMethod,
                                                                         String nickname,
                                                                         String produces,
                                                                         String consumes,
                                                                         String protocols)

构造 @ApiOperation 注解

参数:

constPool - ConstPool instance

value - Provides a brief description of this operation. Should be 120 characters or less for proper visibility in Swagger-UI.

notes - A verbose description of the operation.

tags - A list of tags for API documentation control.

response - The response type of the operation. If the value used is a class representing a primitive (Integer, Long, ...) the corresponding primitive type will be used.

responseContainer - Declares a container wrapping the response. Valid values are "List", "Set" or "Map". Any other value will be ignored.

responseReference - Specifies a reference to the response type. The specified reference can be either local or remote and will be used as-is, and will override any specified response() class.

httpMethod - Corresponds to the `method` field as the HTTP method used. Acceptable values are "GET", "HEAD", "POST", "PUT", "DELETE", "OPTIONS" and "PATCH".

nickname - The operationId is used by third-party tools to uniquely identify this operation. In Swagger 2.0, this is no longer mandatory and if not provided will remain empty.

produces - Takes in comma-separated values of content types. For example, "application/json, application/xml" would suggest this operation generates JSON and XML output.

consumes - Takes in comma-separated values of content types. For example, "application/json, application/xml" would suggest this API Resource accepts JSON and XML input.

protocols - Sets specific protocols (schemes) for this operation. Comma-separated values of the available protocols. Possible values: http, https, ws, wss.

返回:

Annotation instance

annotApiOperation

public static javassist.bytecode.annotation.Annotation annotApiOperation(javassist.bytecode.ConstPool constPool,
                                                                         String value,
                                                                         String notes,
                                                                         String[] tags,
                                                                         Class<?> response,
                                                                         String responseContainer,
                                                                         String responseReference,
                                                                         String httpMethod,
                                                                         String nickname,
                                                                         String produces,
                                                                         String consumes,
                                                                         String protocols,
                                                                         boolean hidden,
                                                                         int code,
                                                                         boolean ignoreJsonView)

构造 @ApiOperation 注解

参数:

constPool - ConstPool instance

value - Provides a brief description of this operation. Should be 120 characters or less for proper visibility in Swagger-UI.

notes - A verbose description of the operation.

tags - A list of tags for API documentation control.

response - The response type of the operation. If the value used is a class representing a primitive (Integer, Long, ...) the corresponding primitive type will be used.

responseContainer - Declares a container wrapping the response. Valid values are "List", "Set" or "Map". Any other value will be ignored.

responseReference - Specifies a reference to the response type. The specified reference can be either local or remote and will be used as-is, and will override any specified response() class.

httpMethod - Corresponds to the `method` field as the HTTP method used. Acceptable values are "GET", "HEAD", "POST", "PUT", "DELETE", "OPTIONS" and "PATCH".

nickname - The operationId is used by third-party tools to uniquely identify this operation. In Swagger 2.0, this is no longer mandatory and if not provided will remain empty.

produces - Takes in comma-separated values of content types. For example, "application/json, application/xml" would suggest this operation generates JSON and XML output.

consumes - Takes in comma-separated values of content types. For example, "application/json, application/xml" would suggest this API Resource accepts JSON and XML input.

protocols - Sets specific protocols (schemes) for this operation. Comma-separated values of the available protocols. Possible values: http, https, ws, wss.

hidden - Hides the operation from the list of operations.

code - The HTTP status code of the response.

ignoreJsonView - Ignores JsonView annotations while resolving operations and types. For backward compatibility

返回:

Annotation instance

annotApiImplicitParams

public static javassist.bytecode.annotation.Annotation annotApiImplicitParams(javassist.bytecode.ConstPool constPool,
                                                                              MvcApiImplicitParam... apiImplicitParams)

构造 @ApiImplicitParams 注解

参数:

constPool - : ConstPool instance

apiImplicitParams - : MvcApiImplicitParam array instance

返回:

Annotation instance

annotApiResponses

public static javassist.bytecode.annotation.Annotation annotApiResponses(javassist.bytecode.ConstPool constPool,
                                                                         MvcApiResponse... apiResponses)

构造 @ApiResponses 注解

参数:

constPool - : ConstPool instance

apiResponses - : MvcApiResponse array instance

返回:

Annotation instance