RESTful風格的API設計工具-Swagger

現在業界對開發部署UI項目的趨勢是先後端分離，也就是說，一部分人只作前端（HTML/CSS/Javascript等），一部分人只作後端（也叫服務器端）。這種開發模式下，一般先後端各自有各自的開發流程、構建和測試工具等。同時，UI前端須要和後端協調好API等接口，而後前端使用Mock server等來模擬後臺提供的數據。可是，這種模式下，就有先後端的集成的問題：經常在開發最後階段，須要先後端進行集成時，才發現一開始約定好的數據結構已經發生變化——即先後端感知到接口變化的週期太長。並且這種API接口、數據結構的變化每每仍是不可避免的。

要解決這個問題，以往的項目開發中，一般的解決辦法是，在項目組開發人員之間預先約定和規範，經過持續集成契約接口測試來避免。固然很顯然僅僅依靠紀律是不夠的，同時在代碼還未完善時進行持續集成測試每每事倍功半，所以，咱們還須要藉助工具幫助咱們提升約定API接口的效率。而Swagger就是這麼一個工具，能夠幫助咱們實現「先後端分離」「及時協商、儘早解決」。

根據官網的描述，Swagger 是一個規範和完整的框架，用於生成、描述、調用和可視化 RESTful 風格的 Web 服務。它容許使客戶端和文件系統做爲服務器以一樣的速度來更新。

Swagger是一個AngularJs開源項目(建議用Chrome瀏覽器打開官網)，Swagger有以下幾個重要部分：

• github-swagger-editor，基於YAML語法定義RESTful API，而後自動生成API文檔。
• github-swagger-ui
• github-swagger-codegen ，自動生成不一樣客戶端語言的代碼。

其中，swagger-editor能夠經過官網swagger-editor-online在線查看Demo打開。