![](https://img-blog.csdnimg.cn/20201014180756916.png?x-oss-process=image/resize,m_fixed,h_64,w_64)
swagger注解
时间会告诉你答案,但不能重来
互联网、信创
展开
-
Swagger注解-@Api
使用场景在 Rest 接口类上边使用。概述标记类为 Swagger 资源类,运行时有效。属性属性名称数据类型默认值说明valueString“”隐式设置操作的标记,遗留支持(读取 description)tagsString[]“”对接口进行分组producesString“”采用都好分支的 content types,例如:appl...原创 2019-04-27 11:40:41 · 5371 阅读 · 2 评论 -
Swagger注解-@ApiImplicitParams 和 @ApiImplicitParam
@ApiImplicitParams使用场景在 Rest 接口方法上使用来指定请求参数概述在 Rest 接口方法上使用来指定请求参数属性属性名称数据类型默认值说明valueApiImplicitParam[]API 可用的参数列表@ApiImplicitParam使用场景场景一:在 Rest 接口上单独使用@ApiImplicitParam 在...原创 2019-04-27 11:41:37 · 15518 阅读 · 0 评论 -
Swagger注解-@ApiModel 和 @ApiModelProperty
@ApiModel使用场景在实体类上边使用,标记类时swagger的解析类概述提供有关swagger模型的其它信息,类将在操作中用作类型时自动内省属性属性名称数据类型默认值说明valueString类名为模型提供备用名称descriptionString“”提供详细的类描述parentClass<?> parentVoid...原创 2019-04-27 11:41:32 · 135319 阅读 · 9 评论 -
Swagger注解-@ApiResponses 和 @ApiResponse
@ApiResponses使用场景在 Rest 接口上使用,用作返回值的描述概述一个包装器,允许列出多个 ApiResponse,若果你需要描述单个 ApiResponse,你仍然必须使用此注解并将@ApiResponse 包装在一个数组中属性属性名称数据类型默认值说明valueApiResponse[]ApiResponse 列表@ApiRespo...原创 2019-04-27 11:41:26 · 75528 阅读 · 4 评论 -
Swagger注解-@ResponseHeader
使用场景作为 @ApiResponse 的属性,作为返回数据的一部分,指定返回 header 信息概述作为返回数据的一部分提供返回数据的 header 信息属性属性名称数据类型默认值说明nameString“”Header’s name.descriptionString“”response header 详细描述responseClas...原创 2019-04-27 11:41:20 · 5731 阅读 · 1 评论 -
Swagger注解-@ApiParam
使用场景在 Rest 接口上或 Rest 接口参数前边使用概述为 Rest 接口参数添加其它元数据(导入到 yapi 中不会被解析)属性属性名称数据类型默认值说明nameString“”参数名称,参数名称将从 filed/method/parameter 名称中派生,但你可以覆盖它,路径参数必须始终命名为它们所代表的路径部分valueString“...原创 2019-04-27 11:41:15 · 85264 阅读 · 0 评论 -
Swagger注解-@ApiOperation
使用场景在 Rest 接口上使用概述描述针对特定路径的操作,通常是 HTTP 方法。具有等效路径的操作被分到单个分组中。HTTP 方法和路径的组合创建了一个独特的操作属性属性名称数据类型默认值说明valueString接口简要说明,120字符或更少notesString“”接口详细描述tagsString[]“”tag 列表,可用于按...原创 2019-04-27 11:41:10 · 15277 阅读 · 0 评论 -
Swagger注解-@Authorization 和 @AuthorizationScope
@Authorization使用场景接口授权,不单独使用,作为 @Api 或 @ApiOperation 的属性使用概述定义要在资源或操作上使用的授权方案。使用的授权方案需要首先在Swagger各级别声明。此注解不直接使用,Swagger不会解析,应该作为 @Api 或 @ApiOperation 属性使用属性属性名称数据类型默认值说明valueString...原创 2019-04-27 11:41:02 · 10760 阅读 · 0 评论 -
Swagger注解-@SwaggerDefinition
使用场景定义 metadata level 时使用,在 Rest 接口或类上使用概述配置定义 metadata level的注解。仍然缺少 Security Requirements,Parameters,Responses属性属性名称数据类型默认值说明hostString“”要在生成的Swagger定义中指定的主机basePathString“”...原创 2019-04-27 11:40:57 · 5696 阅读 · 0 评论 -
Swagger注解-@ExternalDocs
使用场景使用外部文档说明的时候使用,参数,方法,属性上可使用概述定义外部文档说明属性属性名称数据类型默认值说明valueString“”目标文档的简要描述,GFM语法可用于富文本表示urlString引用文档的 URL...原创 2019-04-27 11:40:50 · 1891 阅读 · 0 评论 -
也许是最全面的 Swagger 注解
Swagger注解-@ApiSwagger注解-@ApiOperationSwagger注解-@ApiImplicitParams 和 @ApiImplicitParamSwagger注解-@ApiModel 和 @ApiModelPropertySwagger注解-@ApiResponses 和 @ApiResponseSwagger注解-@ResponseHeaderSwagger...原创 2019-04-27 11:41:52 · 1226 阅读 · 0 评论