近年来大部分web项目采用前后端分离式开发,UI更加丰富的同时也带来了很多调试上的困扰,参数稍有不同就要调试少则数分钟而上不封顶。这时候API文档显得尤其重要,人工去保证API与接口的同步很麻烦效率又低。所以今天介绍一款Spring的自动化API生成工具–Swagger2。此例是与Spring Boot 项目集成首先准备一个Spring Boot项目推荐使用https://start.spring.io/ 快速搭建Spring boot项目 我用的是gradle构建工具,熟悉maven的同学可以使用maven一样的。
下载后解压导入编辑工具,本例使用STS。
添加依赖
maven
swagger依赖
swagger ui依赖
将依赖加入到pom.xml文件中
gradle
swagger
swagger ui
加入到build.gradle的依赖块中