postman——入門基礎——接口文檔示例以及接口文檔系統


https://www.showdoc.cc/里面有詳細示例。這是一個免費開源的用於維護API文檔的工具。能提供在線托管或者部署保存到本地的服務。

                                        一把部署到本地的時候,會安裝Docker容器。Docker是一個開源的應用容器引擎。

 

一個完整的API文檔一般包含以下幾個部分:

(1)、接口名稱;

(2)、簡要描述;

(3)、請求的URL;

(4)、請求方式(get/post等);

(5)、請求參數(參數名、是否必選、參數類型、說明);

(6)、返回示例;

(7)、返回參數說明(參數名、類型、說明);

(8)、備注及責任人;

 

------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

參考網址:https://www.showdoc.cc/storm123

 

 

 


免責聲明!

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



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