注解 | 属性 | 说明 |
---|---|---|
@Api | 用于类上,说明该类的作用。可以标记一个controller类作为swagger的文档资源 | |
value | url的路径 | |
tags | 如果设置这个值,value的值会被覆盖 | |
description | 对Api资源的描述 | |
basePath | 基本路径,可以不用配置 | |
position | 设置多个Api显示的顺序位置 | |
produces | For example, “application/json, application/xml” | |
consumes | For example, “application/json, application/xml” | |
protocols | Possible values: http, https, ws, wss. | |
authorizations | 高级特性认证时配置 | |
hidden | 配置为true 将在文档中隐藏 | |
@ApiOperation | 用于方法上,说明方法的作用,每一个url资源的定义 | |
valu |
swagger2注解说明文档
最新推荐文章于 2022-08-25 00:06:11 发布
本文档详细介绍了Swagger2的配置步骤以及如何在API中使用注解进行接口文档的生成,帮助开发者快速理解和应用Swagger2来提升API文档的管理和开发效率。
摘要由CSDN通过智能技术生成