介面文件生成

測試人生路發表於2020-10-28

一、為什麼要寫介面文件？

1.正規的團隊合作或者是專案對接，介面文件是非常重要的，一般介面文件都是通過開發人員寫的。一個工整的文件顯得是非重要。

2.專案開發過程中前後端工程師有一個統一的檔案進行溝通交流開發，專案維護中或者專案人員更迭，方便後期人員檢視、維護

二、介面文件的格式

介面主要分為四部分：方法、uri、請求引數、返回引數

enter image description here 三、介面文件生成工具

apipost一款很不錯的介面測試工具，它可以生成各種格式的介面文件，有線上版的，markdown格式和word格式的介面文件。

點選分享當前介面

enter image description here 分享 enter image description here

複製連結在瀏覽器中開啟 enter image description here

下載其他格式的介面文件 enter image description here

word格式的介面文件（word只支援json格式的排版，所以百度放回的資料格式在word中顯示不規範）

enter image description here 單個介面的word格式的介面文件可以免費下載，下載多個簡單文件和一個專案的介面文件的時間就需要開會員了。

還有就是apipost下載多個word格式的介面文件的時候，每個介面是單獨的介面文件需要合併。wps和office裡面都有合併功能。

在插入中的物件中找到檔案中的文字然後點選選擇所有介面就可以合併了。

enter image description here enter image description here enter image description here 這就是介面文件生成工具

apipost下載地址：https://www.apipost.cn/?dt=20201028

相關文章