很多开发人员都不喜欢写文档!接口太多了,变化太多了,改完代码还要改文档。流程不规范的团队,经常会出现这样的情况:有时候接口代码变了,文档没有及时更新,前端开发人员不知道;有时候是后台开发人员直接与前端开发人员私下商量一致,直接更新代码不更新文档,久而久之,文档就是去了作用,成了摆设。另外,接口测试工作要借助类似Postman的第三方工具。但事与人违,文档是交流沟通的媒介,文档是项目验收的必备材料,文档是知识和经验的积累!每一个开发人员无法避免的一项工作,就是写文档!
那么,有没有什么工具能够帮助我们自动生成接口文档呢?Swagger就可以帮助我们解决以上困惑。Swagger是一个规范和完整的框架,用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。在Spring Boot项目中,可以将文件的方法、参数和模型紧密集成到服务器端的代码,始终保持同步。Swagger作用主要包括两点:接口文档在线自动生成和功能测试。
下面就是springboot项目集成swagger的步骤:
1,pom文件添加依赖
<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>
<dependency>
<groupId>com.github.xiaoymin</groupId>
<artifactId>swagger-bootstrap-ui</artifactId>
<version>1.8.1</version