<div id="navCategory"></div><p>Swagger是一款遵循 Restful 风格的接口文档开发神器，支持基于 API 自动生成接口文档，接口文档始终与 API 保持同步，不再需要手动编写接口文档，并且采用全注解的方式，开发简单，代码侵入性低，对服务端开发的程序员来说非常方便，可以节约大量写接口文档的时间。除此之外，Swagger 生成的文档还支持在线测试，参数和格式都定好了，直接在界面上输入参数对应的值即可在线测试接口。</p> 讯享网
（1）在 pom.xml 文件中添加 Swagger 的 maven 依赖：
（2）编写Swagger自定义配置类：
在 springmvc.xml 文件中配置创建对象：
（3）在 springmvc.xml 中过滤掉 swagger-ui 的静态资源文件：
（4）在controller类添加swagger的注解：
（5）部署工程，访问路径：
格式：http://服务器ip:端口/项目名称//swagger-ui.html
例子：http://localhost:8080/ssm/swagger-ui.html
见到上面页面，表示整合成功。
修饰controller类，标识这个类是swagger的资源，属性说明：
tags：类的说明，但是tags如果有多个值，会生成多个list
value：也是类的说明，可以使用tags替代
效果图：
修饰controller的方法，表示一个http请求的操作，属性说明：
value：用于方法描述
notes：用于提示内容
tags：可以重新分组，视情况而用）
修饰方法的参数，用于添加参数说明与是否必填等元数据，属性说明：
name：参数名
value：参数说明
required：是否必填
效果图：
修饰对象类，表示对对象类进行说明，用于参数用实体类接收的场景，属性说明：
value：表示对象名，可省略
description：描述，可省略
修饰对象类中的属性，对属性进行说明，属性说明：
- value：字段说明
- name：重写属性名字
- dataType：重写属性类型
- required：是否必填
- example：举例说明
- hidden：是否隐藏
效果图：
修饰类、方法、参数等，表示不显示在swagger文档中，比较简单, 这里不做举例
用于方法，表示单独的请求参数
用于方法，包含多个 @ApiImplicitParam，属性说明：
- name：参数ming
- value：参数说明
- dataType：数据类型
- paramType：参数类型
- example：举例说明
效果图：
这两个注解都表示对响应结果进行说明
value、method、produces
示例：
以上就是详解Swagger接口文档和常用注解的使用的详细内容，更多关于Swagger接口文档 注解的资料请关注脚本之家其它相关文章！
版权声明：本文内容由互联网用户自发贡献，该文观点仅代表作者本人。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容，请联系我们，一经查实，本站将立刻删除。
如需转载请保留出处：https://51itzy.com/kjqy/163935.html