@
Swagger是一个开放源代码软件框架，由大型工具生态系统支持，可帮助开发人员设计，构建，记录和使用RESTful Web服务。尽管大多数用户通过Swagger UI工具识别Swagger，但是Swagger工具集包括对自动文档，代码生成和测试用例生成的支持。
@Api 注解用于标注一个Controller（Class）。在默认情况下，Swagger-Core只会扫描解析具有@Api注解的类，而会自动忽略其他类别资源（JAX-RS endpoints，Servlets等等）的注解。
主要属性如下：
实例:
@ApiOperation 注解在用于对一个操作或HTTP方法进行描述。具有相同路径的不同操作会被归组为同一个操作对象。不同的HTTP请求方法及路径组合构成一个唯一操作。
主要属性：
实例：
@ApiParam作用于请求方法上，定义api参数的注解。
主要属性：
实例：
@ApiImplicitParams、@ApiImplicitParam也可以定义参数.
- @ApiImplicitParams：用在请求的方法上，包含一组参数说明
- @ApiImplicitParam：对单个参数的说明
主要属性：
query --> 请求参数的获取：@RequestParam
header --> 请求参数的获取：@RequestHeader
path（用于restful接口）--> 请求参数的获取：@PathVariable
body（请求体）--> @RequestBody User user
form（普通表单提交）
dataType 参数类型，默认 String，其它值dataType="Integer" defaultValue 参数的默认值
实例：
@ApiResponses、@ApiResponse进行方法返回对象的说明。
主要属性：
实例：
@ApiModel用于描述一个Model的信息（这种一般用在post创建的时候，使用@RequestBody这样的场景，请求参数无法使用@ApiImplicitParam注解进行描述的时候）。
@ApiModelProperty用来描述一个Model的属性。
实例：
@PathVariable用于获取get请求url路径上的参数，即参数绑定的作用，通俗的说是url中"?"前面绑定的参数。
实例：
@RequestParam用于获取前端传过来的参数，可以是get、post请求，通俗的说是url中"?"后面拼接的每个参数。
实例：
参考：
到此这篇swagger注解大全（swaggerui注解）的文章就介绍到这了,更多相关内容请继续浏览下面的相关推荐文章，希望大家都能在编程的领域有一番成就！
版权声明：
本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。
如若内容造成侵权、违法违规、事实不符，请将相关资料发送至xkadmin@xkablog.com进行投诉反馈，一经查实，立即处理！
转载请注明出处，原文链接：https://www.xkablog.com/kjbd-jg/51676.html