Swagger注解-@Api
Swagger注解-@ApiOperation
Swagger注解-@ApiImplicitParams 和 @ApiImplicitParam
Swagger注解-@ApiModel 和 @ApiModelProperty
Swagger注解-@ApiResponses 和 @ApiResponse
Swagger注解-@ResponseHeader
Swagger注解-@ApiParam
Swagger注解-@Authorization 和 @AuthorizationScope
Swagger注解-@SwaggerDefinition
Swagger注解-@ExternalDocs
Springboot 集成 Swagger GitHub 地址
使用场景
作为 @ApiResponse 的属性,作为返回数据的一部分,指定返回 header 信息
概述
作为返回数据的一部分提供返回数据的 header 信息
属性
属性名称 | 数据类型 | 默认值 | 说明 |
---|---|---|---|
name | String | “” | Header’s name. |
description | String | “” | response header 详细描述 |
response | Class<?> | Void.class | Header’s data type |
responseContainer | String | “” | 声明包装响应的容器,有效值为List或Set,任何其他值都将被覆盖 |
Swagger注解-@Api
Swagger注解-@ApiOperation
Swagger注解-@ApiImplicitParams 和 @ApiImplicitParam
Swagger注解-@ApiModel 和 @ApiModelProperty
Swagger注解-@ApiResponses 和 @ApiResponse
Swagger注解-@ResponseHeader
Swagger注解-@ApiParam
Swagger注解-@Authorization 和 @AuthorizationScope
Swagger注解-@SwaggerDefinition
Swagger注解-@ExternalDocs
Springboot 集成 Swagger GitHub 地址