SpringBoot2.0实战（8）整合Swagger2自动生成API文档

Swagger 是一个规范和完整的框架，用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。

相关知识

Swagger官网：https://swagger.io

常用注解：

@Api 用于类，表示标识这个类是swagger的资源

@ApiOperation 用于方法，表示一个http请求的操作

@ApiParam 用于方法，参数，字段说明，表示对参数的添加元数据（说明或是否必填等）

@ApiModel 用于类，表示对类进行说明，用于参数用实体类接收

@ApiModelProperty 用于方法，字段，表示对model属性的说明或者数据操作更改

@ApiIgnore 用于类，方法，方法参数，表示这个方法或者类被忽略

@ApiImplicitParam 用于方法，表示单独的请求参数

@ApiImplicitParams 用于方法，包含多个 @ApiImplicitParam

课程目标

在 第十章：SpringBoot整合MapStruct简化参数映射 的代码基础上，整合 Swagger2 实现自动生成文档

操作步骤

添加依赖

添加 Swagger2 的依赖

编码

新建配置类

@Configuration 注解用于项目启动时自动加载

@EnableSwagger2 注解用于开启 swagger2

为接口添加 swagger 注解

 

为入参添加 swagger 注解

 

验证结果

访问 http:/localhost:8080/swagger-ui.html，即可看到 API 文档

源码地址

本章源码 :https://github.com/caiyuanzi-song/boot.git

总结

Swagger 可以实时生成文档，保证文档的时效性，这有助于前后端联合开发、微服务联合开发等