Web服务开发:Spring集成Swagger，3步自动生成API文档

目录：

1，Spring Boot集成Swagger

2，Swagger接口文档页面

3，常见问题和解决方法

在Sping开发REST接口服务时，API文档是不可缺少的一个重要部分。Swagger框架定义了完整的REST接口文档规范，提供了强大的页面测试功能，能够调试和可视化API接口服务，并且将文档融合到代码中，让维护文档和修改代码整合为一体，使得修改代码逻辑的同时方便的修改文档说明。

Spring集成Swagger只需3步配置，就能在线生成接口文档，调试API功能。

代码下载：https://github.com/jextop/StarterApi/

一，Spring Boot集成Swagger

1. 在pom.xml中添加Swagger依赖

2. 添加SwaggerConfig.java，配置文档信息和扫描包路径

3. （可选）代码中引用Swagger注解，增加接口文档。

- 不添加这些注解时，Swagger自动生成在线文档将使用默认信息。

- 修改代码功能逻辑时，同时维护文档信息。

二，启动项目，打开文档页面

1. http://localhost:8011/swagger-ui.html

2. 展开API信息，点击按钮”Try it out!”，调试接口功能。

三，常见问题和解决方法

l 增加@Api(tags={“xxx中文”})，Swagger文档页面中点击接口名称无法展开详情？

解决：在pom.xml中配置maven依赖使用Swagger2.7.0或以后版本

原因：Swagger2.7.0修复了tags对中文的支持