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