Swagger 是一个规范和完整的框架,用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。在 Spring Boot 中可以通过集成 Swagger 的方式完成文档的自动生成并保持完整的一致性,集成步骤如下:
- 添加 Swagger 相关依赖
<!-- 用于扫描接口配置 -->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.9.2</version>
</dependency>
<!-- 用于显示文档页面 -->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>2.9.2</version>
</dependency>
- 启用 Swagger 文档配置
@Configuration
@EnableSwagger2
@WebContext
public class SwaggerConfig {
@Bean
public Docket petApi() {
Docket docket = new Docket(DocumentationType.SWAGGER_2);
// 配置文档基本描述信息
docket.apiInfo(apiInfo());
// 配置全局参数
docket.globalOperationPar