记得以前写接口，写完后会整理一份API接口文档，而文档的格式如果没有具体要求的话，最终展示的文档则完全决定于开发者的心情。也许多点，也许少点。甚至，接口总是需要适应新需求的，修改了，增加了，这份文档维护起来就很困难了。于是发现了swagger，自动生成文档的工具。
Swagger 是一个规范和完整的框架，用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。总体目标是使客户端和文件系统作为服务器以同样的速度来更新。文件的方法，参数和模型紧密集成到服务器端的代码，允许API来始终保持同步。Swagger 让部署管理和使用功能强大的API从未如此简单。
Swagger 用于定义API文档。
好处
- 前后端分离开发；
- API文档非常明确；
- 测试的时候不需要再使用URL输入浏览器的方式来访问Controller；
- 传统的输入URL的测试方式对于post请求的传参比较麻烦（当然，可以使用postman这样的浏览器插件）；
- spring-boot与swagger的集成简单的一逼；
前后端分离的必要
- 现在的趋势发展，需要把前后端开发和部署做到真正的分离；
- 做前端的谁也不想用Maven或者Gradle作为构建工具；
- 做后端的谁也不想要用Grunt或者Gulp作为构建工具。
前后端需要通过接口来协作
- 可能是JSON格式的RESTFul的接口；
- 可能是XML的接口；
- 重点是后台只负责数据的提供和处理，而完全不处理展现；
- 而前端则负责拿到数据，组织数据并开始展现的工作。
整体文档界面清晰易看
swagger01
swagger02
swagger03
总结
Swagger可以充当前后端交流的重要桥梁，方便快捷。很实用。
Swagger项目允许你生产，显示和消费你自己的RESTful服务。不需要代理和第三方服务。是一个依赖自由的资源集合，它能通过Swagger API动态的生成漂亮的文档和沙盒,因为Swagger UI没有依赖，你可以把他部署到任何服务器环境或者是你自己的机器。
有了这么方便的接口描述文档和接口测试工具，让前后端分离开发更加便于沟通和落地了，测试也可以不依赖于界面单独测试接口，有需要的可以使用起来。
网友评论