OpenAPI接口規範 學習

 

 

學習資料：

GitHub 上接口規範文檔：https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#responseObject

較易理解的接口規範文檔：https://www.breakyizhan.com/swagger/2810.html

如何編寫基於OpenAPI規範的API文檔：https://legacy.gitbook.com/book/huangwenchao/swagger/details

很是好用的OpenAPI文檔編寫工具SWAGGERhub,在線編輯，自動mock：https://app.swaggerhub.com

 

 

在swagger上編寫API文檔，左邊是代碼區，右邊是相應的UI展現。

編寫完成後，將文檔下載到本地。

下載OpenAPI 3 / Swagger API 模擬服務器：http://stoplight.io/platform/prism/

在cmd中進入prism所在的文件夾，用以下命令啓動模擬服務器：

（其中 --cors 是用來解決跨域問題的，不然在swagger在線編輯器上沒法執行）

在接口文檔中加入以下語句：

即可以經過瀏覽器訪問輸出了：

不過因爲prism如今只支持OpenAPI2.0 ，使用OpenAPI3.0.0會沒法mock到數據。推薦使用更好用的工具SWAGGERhub！！

在線編輯，自動mock。