答：介面文件，可以有很多種形式。
以最常見的http協議下的介面為例，首先對整套介面的鑑權等機制要做個說明。
例子：這裡列出了他這套介面支援什麼鑑權登入方式，引數傳遞方式，預定義的常見錯誤等等。
然後一般對每個具體的介面需要包括
1.簡單描述
2.介面的url
3.http方法
4.引數
5.呼叫資料舉例
舉個例子：以下是 github 的介面文件中對於「列出某個使用者點了贊的專案」的介面文件
來自activity/starring/#star-a-repository
list repositories being starred --- 這是標題
list repositories being starred by a user. --- 這是對介面功能的簡單描述：列出指定使用者點過贊的專案
get /users/:username/starred --- 這裡指明了用get方法和這個url來呼叫這個介面。其中:username表示介面url中可變的部分
list repositories being starred by the authenticated user.這是另一種呼叫方式，這裡也是對介面功能的簡單描述：列出當前登入的使用者點過贊的專案
get /user/starred -- 這裡指明了用get方法和這個url來呼叫這個介面。
parameters ---這裡具體介紹了可選引數的引數名，資料型別，和業務意義描述
response --- 這裡給出了乙個正確的呼叫後得到的返回值的例子
status: 200 ok
link: ; rel="next",
; rel="last"
[ ,
"allow_rebase_merge": true,
"allow_squash_merge": true,
"allow_merge_commit": true,
"subscribers_count": 42,
"network_count": 0
}]a
而介面測試報告。由於大多採用自動化測試，一般會直接用xunit系列的報告格式。如果有特殊需求，則從這些報告裡提取資料後自己生產特定格式的報告，乙個xunit系列的報告長這樣：
如果你是手動測，那麼手動建立報告可以自己定義乙個格式。實際上我曾經做過一些用了這種比較漂亮的視覺化效果的報告，像這樣的：
這些都好做，只要你想得出來，用簡單的html+js就可以做。
原問題討論來自以下付費社群，掃碼即可加入。
Postman介面測試 呼叫介面
通過介面文件 fiddler,charles,f12等抓包獲取介面資訊 1 請求方式 get post 2 引數方式 有哪些引數 引數型別 必填項 3 是否帶請求頭 帶cookie headers 1 建立集合 圖1 建立集合 2 新增請求 圖2 在集合下新增請求 3 認識postman的傳參型別 ...
怎麼呼叫api介面
api的簡單呼叫,呼叫api的方法 方法一 用前端方法呼叫api 完整 1 doctype html 23 html lang en 4 head 5 meta charset utf 8 6 title title title 7head 8 style 910 style 11 body 12 ...
怎麼呼叫api介面
api的簡單呼叫,呼叫api的方法 方法一 用前端方法呼叫api 完整 1 doctype html 23 html lang en 4 head 5 meta charset utf 8 6 title title title 7head 8 style 910 style 11 body 12 ...