API设计工具——Swagger

Swagger

Swagger包括库、编辑器、代码生成器等不少部分，这里咱们主要讲一下Swagger Editor。这是一个彻底开源的项目，而且它也是一个基于Angular的成功案例，咱们能够下载源码并本身部署它，也能够修改它或集成到咱们本身的软件中。

在Swagger Editor中，咱们能够基于YAML语法定义咱们的RESTful API，而后它会自动生成一篇排版优美的API文档，而且提供实时预览。相信大多数朋友都遇到过这样一个场景：明明调用的是以前约定好的API，拿到的结果却不是想要的。可能由于是有人修改了API的接口，却忘了更新文档；或者是文档更新的不及时；又或者是文档写的有歧义，你们的理解各不相同。总之，让API文档老是与API定义同步更新，是一件很是有价值的事。下面咱们经过一个例子来感觉一下Swagger给咱们带来的好处。

首先咱们须要安装一个Swagger Editor，或者也能够直接使用在线版本http://editor.swagger.io/。若是须要在本地启动编辑器，执行如下三行命令便可

（前提是已经安装好了Node.js）：

Node.js 安装访问：https://my.oschina.net/guoenzhou/blog/1536976

 

git clone https://github.com/swagger-api/swagger-editor.git
cd swagger-editor
npm start
或者
cnpm start