在開發過程中,前後端最糟心的事就是溝通接口,在此過程中,吵得最兇的根源就在于接口文檔的不完善、亂、難于使用,甚至都沒有統一管理接口的地方。本文将分享一款線上接口文檔管理工具:“斯瓦格”,同時我将用華為AppCloud進行搭建,每一步都會記錄下來,如果你想了解一下“斯瓦格”和AppCloud搭建過程,希望你好好看看本文,讓我們直接開始。
一、什麼是“斯瓦格”?
“斯瓦格”從本質上來講是定義API(應用程式程式設計接口)結構的方式,它的核心就是“規範”二字,“斯瓦格”規範了如何定義參數、路徑是什麼樣子的、響應應該怎麼寫、模型如何建立等。
“斯瓦格”支援多種資料格式,比如json、txt、xml、html,也支援多種接口類型,比如HTTP、WebSocket等。
“斯瓦格”那麼強大,都有哪些好處呢?
- 有了“斯瓦格”,接口變得十分規範,閱讀起來非常友善;
- 生成測試文檔非常友善,不需要手動一個接口一個接口去寫,節省了大量的時間;
- 可以線上導出不同格式的文檔,滿足多種場景需求;
- 支援絕大數主流語言,相容性強大。
二、搭建“斯瓦格”
2.1 在AppBazaar購買“斯瓦格”應用
我們會基于華為雲AppCloud進行搭建,首先通路AppBazaar的官網https://console.huaweicloud.com/appbazaar:
在開始之前,必須保證你注冊了華為雲的賬号且開通了實名認證。
找到“AppCloud搭建“斯瓦格”線上文檔管理平台”,點選進入:
在此頁面,你可以簡單了解一下“斯瓦格”基本知識、所用技術、支援的環境以及“斯瓦格”的預覽圖。
下一步,點選【立即購買】:
勾選【我已閱讀并同意 《華為雲商城通用商品使用者協定》】,然後點選【送出訂單】按鈕:
支付0元後,你就會在【訂單管理】界面看到你剛剛購買的“斯瓦格”應用:
2.2 建構“斯瓦格”應用
在在【訂單管理】界面,點選“AppCloud搭建“斯瓦格”線上文檔管理平台”的【去建構應用】按鈕:
在“01 建立應用”步驟中填寫應用的基礎資訊:
- 應用名稱:wljlsmz-“斯瓦格”線上文檔管理平台
- 關聯華為雲DevCloud:在華為雲DevCloud中同步建立新項目
- 應用簡介:用于線上接口管理
- 選擇方案:AppCloud搭建“斯瓦格”線上文檔管理平台
點選下一步,會看到提示“AppCloud目前隻面向【北京四區域】提供服務,您在北京四區尚未開通華為雲DevCloud服務,請開通後重試。”:
根據自己的實際情況來,我這邊确實沒有開通。
點選【前往開通】:
勾選【我已經閱讀并同意以上使用聲明】,點選【确定】按鈕。
在此頁面,我們選擇“基礎版”,點選【免費開通】按鈕:
配置全部預設,勾選【我已經閱讀并同意 《軟體開發服務使用聲明》】,然後點選【下一步】按鈕:
點選【去支付】:
點選【确認付款】:
看到此提示就代表支付成功:
然後我們再回到“斯瓦格”建立應用的界面,再次點選【下一步】按鈕:
可以看到已經成功進入“02 基礎配置”頁簽。
在此界面,我們需要根據提示操作三步:
- 下載下傳“斯瓦格”軟體包
下載下傳到本地後,我們就看到了“siwage-2.1.5.war”檔案,該檔案就是“斯瓦格”的部署包,下一步我們就需要把這個包傳到華為雲中:
- 去華為雲DevCloud“釋出”上傳“斯瓦格”軟體包
點選【立即前往】,然後點選【上傳】按鈕:
選擇第一步下載下傳的“siwage-2.1.5.war”包,在頁面右下角可以看到上傳進度:
上傳成功後就可以在軟體釋出庫清單看到我們剛剛上傳的部署包:
然後我們再回到“02 基礎配置”頁面。
- 選擇上傳的“斯瓦格”軟體包
在此步驟,就可以重新整理下拉到我們剛剛在華為雲DevCloud上傳的“斯瓦格”軟體包:
選擇好包後,我們下面開始進行主機配置,我們填寫好“雲伺服器名稱”和“ECS密碼”後,點選【開始執行】按鈕:
點選【确認執行】按鈕:
然後就會進入“03 一鍵部署”頁簽:
此過程會經曆5個步驟:
- 購買ECS
- 建立主機組
- 建立主機
- 模闆建立部署任務
- 執行部署任務
此過程需要等待5-10分鐘左右的時間。
當我們看到部署的5個步驟全部完成時,會提示“部署成功”,這個時候,點選【下一步】:
在此,我們看到“斯瓦格”已經部署完畢了,可以通路了。
友情提醒:如果你隻是搭建體驗,并不想立即應用的生産或者開發環境的,一定要注意,體驗完畢及時釋放資源,否則可能一直産生計費。
我們在此點選【打開應用】按鈕:
至此部署就完成了。
三、資源管理
通路頁面https://console.huaweicloud.com/appcloud/myapp,就可以進入“我的應用”頁面:
在此頁面,我們看到剛剛部署成功的“斯瓦格”線上文檔管理平台,因為我也是體驗為主,是以我需要及時釋放資源,點選【釋放資源】按鈕即可:
釋放的過程中,會提示“資源釋放中”:
此過程跟部署一樣,需要等待一會。
釋放完成後,會提示“釋放完成”:
我們再去看“我的應用”界面的時候,就發現該應用顯示的就是“未部署”的狀态:
如果你想要删除此應用,直接點選【删除應用】的按鈕即可,在此我們不删除了。
四、總結
從總體的部署過程來說,還是相對比較簡單的,基本上沒有很複雜的步驟,隻是有些前置條件,如果你之前沒玩過,可能第一次需要開通一下。本文使用AppCloud搭建“斯瓦格”線上文檔管理平台,步驟寫的非常詳細,截圖也是每一步都截了,我相信隻要你按照我的步驟一步一步來,基本上不會出問題,最後感謝您的閱讀,如果有任何問題,歡迎在下方評論區與我讨論。