用Swagger生成接口文檔

Swagger簡介

在系統設計的時候，各個應用之間每每是經過接口進行交互的。所以接口的定義在整個團隊中就變得尤其重要。咱們能夠把接口的規範用接口描述語言進行描述，而後Swagger能夠根據咱們定義的接口規範生成對應的接口文檔。它生成的接口文檔提供了接口測試功能。咱們只須要填上對應的參數，而後點擊調用，就能夠完成一次接口測試，很是方便。就像下圖展現的那樣。

 

不只如此，Swagger還可以根據接口規範自動生成對應的接口代碼！好比Java客戶端代碼、Java服務端代碼等。這個東西減小了接口規範的溝通成本，讓開發人員可以直奔主題進行編碼。開發人員甚至都不須要寫客戶端的代碼了，只須要實現服務端代碼便可。

Swagger使用方法

首先，打開Swagger的編輯器。經過網頁也能夠打開：http://editor.swagger.io/。打開以後是下圖這樣，按照它給的格式就能夠寫出接口文檔啦~

 

小結

Swagger節省了開發人員的時間。只需編寫一次接口規範，就能夠屢次使用。用程序員的話來說就是提升了接口規範的可複用性。