接口測試--接口文檔規範

接口測試的依據，每每不是需求文檔，而是接口文檔。

那麼，接口文檔的準確性便相當重要，本文推薦apipost接口文檔生成工具生成的接口文檔，供你們參考。

接口文檔無論以什麼形式存在，須要包含的內容有：

1. 接口名稱
2. 接口類型
3. 輸入參數

每一個參數名；

每一個參數類型；

每一個參數業務含義；

每一個是否可空；

每一個字段長度（可選，通常須要提供，有嚴格要求的字段需特別註明）；

每一個參數的單位（可選，金額類字段需註明）；

d. 輸出結果

每一個參數名；

每一個參數類型；

每一個參數業務含義；

每一個是否可空；

每一個參數的單位（可選，金額類字段需註明）；

返回狀態的取值範圍及其業務含義。

在線格式接口文檔

word格式接口文檔

接口測試接口文檔生成工具apipost下載地址：

ApiPost - 可直接生成文檔的API調試、管理工具​www.apipost.cn