1. 程式人生 > >用Swagger生成介面文件

用Swagger生成介面文件

Swagger簡介

在系統設計的時候,各個應用之間往往是通過介面進行互動的。因此介面的定義在整個團隊中就變得尤為重要。我們可以把介面的規範用介面描述語言進行描述,然後Swagger可以根據我們定義的介面規範生成對應的介面文件。它生成的介面文件提供了介面測試功能。我們只需要填上對應的引數,然後點選呼叫,就可以完成一次介面測試,非常方便。就像下圖展示的那樣。

 

不僅如此,Swagger還能夠根據介面規範自動生成對應的介面程式碼!比如Java客戶端程式碼、Java服務端程式碼等。這個東西減少了介面規範的溝通成本,讓開發人員能夠直奔主題進行編碼。開發人員甚至都不需要寫客戶端的程式碼了,只需要實現服務端程式碼即可。

Swagger使用方法

首先,開啟Swagger的編輯器。通過網頁也可以開啟:http://editor.swagger.io/。開啟之後是下圖這樣,按照它給的格式就可以寫出介面文件啦~

 

小結

Swagger節省了開發人員的時間。只需編寫一次介面規範,就可以多次使用。用程式設計師的話來講就是提高了介面規範的可複用性。

 

Swagger簡介

在系統設計的時候,各個應用之間往往是通過介面進行互動的。因此介面的定義在整個團隊中就變得尤為重要。我們可以把介面的規範用介面描述語言進行描述,然後Swagger可以根據我們定義的介面規範生成對應的介面文件。它生成的介面文件提供了介面測試功能。我們只需要填上對應的引數,然後點選呼叫,就可以完成一次介面測試,非常方便。就像下圖展示的那樣。

 

不僅如此,Swagger還能夠根據介面規範自動生成對應的介面程式碼!比如Java客戶端程式碼、Java服務端程式碼等。這個東西減少了介面規範的溝通成本,讓開發人員能夠直奔主題進行編碼。開發人員甚至都不需要寫客戶端的程式碼了,只需要實現服務端程式碼即可。

Swagger使用方法

首先,開啟Swagger的編輯器。通過網頁也可以開啟:http://editor.swagger.io/。開啟之後是下圖這樣,按照它給的格式就可以寫出介面文件啦~

 

小結

Swagger節省了開發人員的時間。只需編寫一次介面規範,就可以多次使用。用程式設計師的話來講就是提高了介面規範的可複用性。