1. 程式人生 > >[Swagger]swagger構建你的api文件

[Swagger]swagger構建你的api文件

Swagger能成為最受歡迎的REST APIs文件生成工具之一,有以下幾個原因:

Swagger 可以生成一個具有互動性的API控制檯,開發者可以用來快速學習和嘗試API。
Swagger 可以生成客戶端SDK程式碼用於各種不同的平臺上的實現。
Swagger 檔案可以在許多不同的平臺上從程式碼註釋中自動生成。
Swagger 有一個強大的社群,裡面有許多強悍的貢獻者。

下面開始配置教程
檔案:https://download.csdn.net/download/drdongshiye/10822532
1.swagger editor
下載可用的Swagger spec(規範)配置檔案,一般預設yml檔案(使用 YML 替換JSON。 YML 句法比 JSON 可讀性高。使用 YML ,空格很重要。新段落需要縮排兩個空格。冒號表示個物件。連字元代表一個 sequence 或者 list (像一個 array)。如果你下載這個檔案而不是複製貼上,你基本不會碰到空格問題)
Swagger editor 告訴你檔案如何被輸出,你也可以看到驗證出來的錯誤。沒有這個線上編輯器,你只能在執行程式碼的時候才能知道 YML 句法是否有效 (並且看到錯誤提示, YAML 檔案也不能被正確解析)。

將該檔案下載到本地 File->save as YAML檔案
注:在swagger editor 可以校驗檔案是否正確
2.配置swagger ui
1、Github: Swagger UI。下載、解壓。只需要用到 dist 資料夾。除非你想重新生成 dist 中的檔案,才會用到別的。
2、開啟 dist > index.html
3、找到:url = “http://petstore.swagger.io/v2/swagger.json”;
4、值改成 swagger.yaml 的路徑
5、儲存開啟index.html

------------------------以上內容即可完成swagger基本使用--------------------------------

上傳檔案到 web 主機
除了本地瀏覽 Swagger 檔案,你也可以使用 XAMPP 在本地執行一個 web 伺服器
1、下載安裝XAMPP
2、在你的應用程式資料夾中開啟 XAMPP 資料夾,啟動 manager-osx 控制檯
3、單擊 Manage Servers tab
4、選擇 Apache Web Server 單擊 Start
5、開啟 XAMPP 中的 htdocs 資料夾。如果是Mac,通常在 /Applications/XAMPP/xamppfiles/htdocs。
6、將 dist 資料夾拖到此處
7、在你的瀏覽器中瀏覽 localhost/dist
就可以看到 Swagger UI的展示。
體驗 Swagger UI
1、用瀏覽器瀏覽 Swagger UI。
2、在右上角,單擊 Authorize 並且輸入你的 Mashape API Key。如果你沒有 Mashape API Key,你可以3、使用 EF3g83pKnzmshgoksF83V6JB6QyTp1cGrrdjsnczTkkYgYrp8p。
4、去 Google Maps 搜尋一個地址。
5、從 URL 中去獲取經緯度,將其插入到你的 Swagger UI中(比如:1.3319164 for lat, 103.7231246 for lng)
6、單擊 Try it out。
如果成功,你應該可以看到 response body 的響應:9 c, Mostly Cloudy at South West, Singapore
如果你看到了Not supported,嘗試調整經緯度。
如果你重新整理了介面,你要重新輸入 API Key。

參考:https://www.cnblogs.com/JoiT/p/6378086.html