swagger官网：传送门
swagger是一个Api框架，就是一个工具，就比如我们可以使用postman测试接口一样，swagger主要作用是生成RESTFUL接口的文档并且可以提供功能测试；
通过swagger可以获取项目的api结果，生成清晰的api文档，并可以进行一些自动化测试
- Swagger-tools:提供各种与Swagger进行集成和交互的工具。例如模式检验、Swagger 1.2文档转换成Swagger2.0文档等功能。
- Swagger-core:用于Java/Scala的的Swagger实现。与JAX-RS(Jersey、Resteasy、CXF…)、Servlets和Play框架进行集成。
- Swagger-js: 用于JavaScript的Swagger实现。
- Swagger-node-express: Swagger模块，用于node.js的Express web应用框架。
- Swagger-ui：一个无依赖的HTML、JS和CSS集合，可以为Swagger兼容API动态生成优雅文档。
- Swagger-codegen：一个模板驱动引擎，通过分析用户Swagger资源声明以各种语言生成客户端代码。
说明：
swagger3 摒弃了@EnableSwagger2这个注解，改成了@EnableOpenApi
swagger3 使用DocumentationType.OAS_30，swagger2版本这里是DocumentationType.SWAGGER_2
访问路径
http:IP:端口号/swagger-ui/index.html
添加如下内容，使得只在测试环境中才会有swagger，正式环境不显示
Swagger默认是一个default分组：
可以通过分组来实现对不同API的分类，分组可以使用Docket的groupName属性区分不同分组，并可以在Swagger中创建多个Docket的Bean实例来定义不同分组；
这里我只配置了两个分组，可以多创建几个Docket实例实现多分组；
分组效果：
用于类上
@Api：用在请求的类上，表示对类的说明
tags=“说明该类的作用，可以在UI界面上看到的注解”
value=“该参数没什么意义，在UI界面上也看到，所以不需要配置”
用于方法上
@ApiOperation：用在请求的方法上，说明方法的用途、作用
value=“说明方法的用途、作用”
notes=“方法的备注说明”
@ApiImplicitParams：用在请求的方法上，表示一组参数说明
@ApiImplicitParam：用在@ApiImplicitParams注解中，指定一个请求参数的各个方面
name：参数名
value：参数的汉字说明、解释
required：参数是否必须传
paramType：参数放在哪个地方
· header --> 请求参数的获取：@RequestHeader
· query --> 请求参数的获取：@RequestParam
· path（用于restful接口）–> 请求参数的获取：@PathVariable
· div（不常用）
· form（不常用）
dataType：参数类型，默认String，其它值dataType=“Integer”
defaultValue：参数的默认值
@ApiResponses：用在请求的方法上，表示一组响应
@ApiResponse：用在@ApiResponses中，一般用于表达一个错误的响应信息
code：数字，例如400
message：信息，例如"请求参数没填好"
response：抛出异常的类
用于对象类
@ApiModel：用于响应类上，表示一个返回响应数据的信息
（这种一般用在post创建的时候，使用@RequestBody这样的场景，
请求参数无法使用@ApiImplicitParam注解进行描述的时候）
@ApiModelProperty：用在属性上，描述响应类的属性
value–字段说明
name–重写属性名字
dataType–重写属性类型
required–是否必填
example–举例说明
hidden–隐藏
@ApiModel的功能：
1、当请求数据描述，即 @RequestBody 时， 用于封装请求（包括数据的各种校验）数据；
2、当响应值是对象时，即 @ResponseBody 时，用于返回值对象的描述。
当请求数据描述时， @RequestBody 时的使用
借鉴：
【1】SpringBoot从0到实战8：简单使用Swagger生成接口开发文档
【2】 Swagger3 常用配置注解讲解 结合SpringBoot2
【3】Swagger笔记—Swagger3详细配置
【4】Swagger3的基本使用
版权声明：
本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。
如若内容造成侵权、违法违规、事实不符，请将相关资料发送至xkadmin@xkablog.com进行投诉反馈，一经查实，立即处理！
转载请注明出处，原文链接：https://www.xkablog.com/rfx/14082.html