接口測試--接口文檔規(guī)范

接口測試的依據(jù)，往往不是需求文檔，而是接口文檔。

那么，接口文檔的準確性便至關重要，本文推薦apipost接口文檔生成工具生成的接口文檔，供大家參考。

接口文檔不管以什么形式存在，需要包含的內(nèi)容有：

1.接口名稱

2.接口類型

3.輸入?yún)?shù)

4.每個參數(shù)名；

每個參數(shù)類型；每個參數(shù)業(yè)務含義；

每個是否可空；

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

每個參數(shù)的單位（可選，金額類字段需注明）；

5. 輸出結果

每個參數(shù)名；

每個參數(shù)類型；

每個參數(shù)業(yè)務含義；

每個是否可空；每個參數(shù)的單位（可選，金額類字段需注明）；

返回狀態(tài)的取值范圍及其業(yè)務含義。

在線格式接口文檔

word格式接口文檔

接口測試接口文檔生成工具apipost下載地址：https://www.apipost.cn