Swagger

Swagger 介绍

OpenAPI规范是Open API Initiative（Linux基金会合作项目）中的社区驱动开放规范。

OpenAPI规范（OAS）为REST API定义了一个标准的，与编程语言无关的接口描述，它允许人和计算机发现和理解服务的功能，而不需要访问源代码，额外的文档或检查网络流量。当通过OpenAPI正确定义时，消费者可以用最少量的实现逻辑理解远程服务并与之交互。类似于低级编程所做的接口描述，OpenAPI规范消除了调用服务时的猜测。

用于机器可读的API定义文档的用例包括但不限于：交互式文档; 用于文档，客户端和服务器的代码生成; 和测试案例的自动化。OpenAPI文档描述了API的服务，并以YAML或JSON格式表示。这些文档可以被静态地生成或者提供，或者从应用程序动态生成。

OpenAPI规范不需要重写现有的API。它不需要将任何软件绑定到服务上 - 被描述的服务甚至可能不被其描述的创建者所拥有。但是，它确实需要在OpenAPI规范的结构中描述服务的功能。并不是所有的服务都可以用OpenAPI来描述 - 这个规范并不是为了涵盖每种可能的REST API风格。OpenAPI规范没有要求特定的开发过程，例如设计优先或代码优先。它通过建立与REST API的明确交互来促进任何技术。

参考：
http://blog.csdn.net/zmh458/article/details/78766895