SpringBoot中使用Swagger生成RESTful规范API文档

Swagger是为了描述一套标准的而且是和语言无关的REST API的规范。对于外部调用者来说，只需通过Swagger文档即可清楚Server端提供的服务，而不需去阅读源码或接口文档说明。

官方网站为：http://swagger.io
中文网站：http://www.sosoapi.com

背景
前后端分离
1、前后端仅仅通过异步接口(AJAX/JSON)来编程
2、前后端都各自有自己的开发流程，构建工具，测试集合
3、关注点分离，前后端变得相对独立并松耦合

开发流程
1、后台编写和维护接口文档，在 API 变化时更新接口文档
2、后台根据接口文档进行接口开发
3、前端根据接口文档进行开发
4、开发完成后联调和提交测试

三大功能
1、Swagger Editor: Swagger提供的一个编辑器，用来通过Swagger提供的特定的YAML语法来编写API文档
2、Swagger Codegen: 代码生成器
3、Swagger UI: YAML语法定义我们的RESTful API，然后它会自动生成一篇排版优美的API文档，并且提供实时预览。

面临问题
1、没有统一的文档编写规范，导致文档越来越乱，无法维护和阅读。
2、开发中的接口增删改等变动，需要较大的沟通成本。
3、对于一个新需求，前端开发的接口调用和自测依赖后台开发完毕。
4、将接口的风险后置，耽误项目时间。

<