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。


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM