【视频&交流平台】
à Spring Boot视频：http://t.cn/R3QepWG
à Spring Cloud视频：http://t.cn/R3QeRZc
à Spring Boot Shiro视频：http://t.cn/R3QDMbh
à Spring Boot交流平台：http://t.cn/R3QDhU0
à Spring Boot 2.0 SpringData和JPA视频：
http://t.cn/R1pSojf
前言：
我们在编写了大量的接口之后，如果接口的调用者不是自身的话，那么就会面临要编写接口文档的苦恼，这时候Swagger就应运而生了。通过本篇文章你就会了解到如下的内容：
（1）Swagger的产生；
（2）Swagger的介绍；
（3）Swagger的组件；
（4）其它API生成工具；
初体验地址：http://petstore.swagger.io/
一、Swagger的产生
我们的RESTful API需要面对多个开发人员或多个开发团队：IOS开发、Android开发或是Web开发等。为了减少与其他团队平时开发期间的频繁沟通成本，传统做法我们会创建一份RESTful API文档来记录所有接口细节，然而这样的做法有以下几个问题：
（1）接口多，不利于维护：由于接口众多，并且细节复杂（需要考虑不同的HTTP请求类型、HTTP头部信息、HTTP请求内容等），高质量地创建这份文档本身就是件非常吃力的事，下游的抱怨声不绝于耳。
（2）接口调整，文档不一致： 随着时间推移，不断修改接口实现的时候都必须同步修改接口文档，而文档与代码又处于两个不同的媒介，除非有严格的管理机制，不然很容易导致不一致现象。
Swagger的产生就是为了解决以上这些问题。
二、Swagger的介绍
swagger 英[ˈswægə(r)]
Swagger 是一个规范和完整的框架，用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。总体目标是使客户端和文件系统作为服务器以同样的速度来更新。文件的方法，参数和模型紧密集成到服务器端的代码，允许API来始终保持同步。Swagger 让部署管理和使用功能强大的API从未如此简单。
三、Swagger的组件
Swagger 分成一些不同的块。
Swagger spec：这一块对元素的嵌套、命令等采用官方模式。如果你想要对 Swagger 文件手动编码，你必须非常熟悉 Swagger spec。
Swagger editor：这是在线编辑器，用于验证你的 YML 格式的内容是否违反 Swagger spec 。YML 是一种句法，依赖于空格和嵌套。你需要对 YML 句法很熟悉才能很好的遵守 Swagger spec 规范。Swagger 编辑器会标出错误并且给你格式提醒（Swagger spec 文件可以使用 JSON 或者 YAML 中的任意一种格式）。
Swagger-UI：这是一套 HTML/CSS/JS 框架用于解析遵守 Swagger spec 的 JSON 或 YML 文件，并且生成API文档的UI导航。它可以将你的规格文档转换成Swagger Petsotre-like UI。
Swagger-codegen： 这个工具可以为不同的平台生成客户端 SDK（比如 Java、JavaScript、Python 等）。这些客户端代码帮助开发者在一个规范平台中整合 API ，并且提供了更多健壮的实现，可能包含了多尺度、线程，和其他重要的代码。SDK 是用于支持开发者使用 REST API 的工具。
Swagger-validator：这个小工具是用来校验生成的文档说明文件是否符合语法规定的。用法非常简单，只需url地址栏，根路径下加上一个参数url，参数内容是放swagger说明文件的地址，即可校验。
四、其它API生成工具
4.1 RAP
RAP是阿里的一套完整的可视化接口管理工具，可以定义接口结构，动态生成模拟数据，校验真实接口正确性。不仅如此，RAP围绕接口定义，提供了一系列包括团队管理、项目管理、文档版本管理、mock插件等服务。
有关RAP的使用，RAP官网提供了非常详细的wiki和视频教程。与Swagger需要使用标记语言编写不同，RAP可以完全可视化地定义项目相关信息，定义接口的请求响应等等，学习成本较低。RAP还为后端开发人员提供了校验接口的功能，为前端开发人员提供了mock数据的工具等。
Github地址：https://github.com/thx/rap2-delos
阿里妈妈前端团队出品的开源接口管理工具RAP第二代：
http://rap2.taobao.org/
4.2 yapi
YApi 是高效、易用、功能强大的 api 管理平台，旨在为开发、产品、测试人员提供更优雅的接口管理服务。可以帮助开发者轻松创建、发布、维护 API，YApi 还为用户提供了优秀的交互体验，开发人员只需利用平台提供的接口数据写入工具以及简单的点击操作就可以实现接口的管理。
特性
（1）基于 Json5 和 Mockjs 定义接口返回数据的结构和文档，效率提升多倍
（2）扁平化权限设计，即保证了大型企业级项目的管理，又保证了易用性
（3）类似 postman 的接口调试
（3）自动化测试, 支持对 Response 断言
（4）MockServer 除支持普通的随机 mock 外，还增加了 Mock 期望功能，根据设置的请求过滤规则，返回期望数据
（5）支持 postman, har, swagger 数据导入
（6）免费开源，内网部署，信息再也不怕泄露了
Github地址：https://github.com/YMFE/yapi
4.3 RAML
RAML(RESTfulAPI Modeling Language 即 RESTful API 建模语言)是对 RESTful API的一种简单和直接的描述。它是一种让人们易于阅读并且能让机器对特定的文档能解析的语言。RAML 是基于 YAML,能帮助设计RESTful API 和鼓励对API的发掘和重用,依靠标准和最佳实践从而编写更高质量的API。通过RAML定义,因为机器能够看得懂,所以可以衍生出一些附加的功能服务,像是解析并自动生成对应的客户端调用代码、服务端代码结构, API说明文档。
官网：https://raml.org/
4.4 API Blueprint
APIBlueprint是使用Markdown来定义API的，Markdown相比前面两个RAML、JSON门槛又降低了一大截。同时API Blueprint与前面的Swagger、RAML一样也能提供可视化的文档界面与Mock Server的功能。不过其Mock能力比较弱。
官网地址：https://apiblueprint.org/
整理参考：
接口文档管理工具-Postman、Swagger、RAP
http://qa.blog.163.com/blog/static/190147002201611155418810
yapi
https://github.com/YMFE/yapi
RAP
https://github.com/thx/rap2-delos
RAML
https://raml.org/
API Blueprint
https://apiblueprint.org/
