網友評分: 5分
Swagger Editor 是一款針對REST APIs文檔的在線生成工具,可以生成一個具有互動性的API控制臺,開發者可以用來快速學習和嘗試API。還可以生成客戶端SDK代碼用于各種不同的平臺上的實現。
運行在任何環境
編輯器在任何開發環境中工作,無論是在本地還是在Web上。
智能反饋
在編寫簡潔的反饋和錯誤處理時,驗證OAS遵從性的語法
即時可視化
可視化地呈現API規范并與API交互,同時定義它
智能自動完成
用智能和智能自動完成更快地編寫語法
完全可定制
易于配置和定制任何東西,從線間距到主題
關于你的開發
在每個流行語言中為API生成服務器存根和客戶端庫
Swagger Editor界面分為導航欄和工作區。導航欄是對接口文檔的處理用,工作區就是我們花時間最多的地方。分為左右區域,左邊是編輯區,右邊是顯示區。左邊編輯區使用的YAML語法來編寫,只要一修改右邊顯示區立刻有變化,使用很便捷。進入swagger edit會默認填入一個demo文檔,通常我們只需要修改demo文檔,就能制作我們想要的接口文檔。
編寫完文檔點擊展示區的excute,進行測試接口。
File
這個用來導出/引入接口文件在swagger edit里面進行編輯,也可以輸出YAML/JSON格式。這個如果你是非在線版,編輯一半想下次在編輯,建議先導出備份,避免數據丟失。
convert to YAML
把編輯區轉換成YAML格式。
Generate Server
把接口文檔生成服務器文件,導出一個壓縮包,接口文檔生成java、js等服務器文件。很實用工具,讓你寫少很多代碼。
導出spring-boot
導出nodeJS
Generate Client
生成查看接口文檔。編寫好下一步就是展示。這里可以選擇導出什么格式的接口文檔。