接口文檔的特點
接口文檔，顧名思義就是對接口說明的文檔。好的接口文檔包含了對接口URL，參數以及輸出內容的說明，我們參照接口文檔就能編寫出一個個的測試用例。而且接口文檔詳細的話，測試用例編寫簡單，不會遺漏。
如果一個接口文檔沒有寫清楚，你從文檔中分不出哪些兒參數是必需的，哪些兒是非必須的，而且沒有參數的取值說明，返回值的結構等信息的話，測試人員是無法編寫相應的測試用例的。但是由於開發人員不願意寫文檔，所以很多接口文檔相對來說比較簡單，模糊不清，這對我們做接口自動化測試是很大的阻礙。
7.2 接口文檔的結構
接口文檔可以包含很多信息，有的願意寫就可以多寫的，不太願意寫的話，就寫的信息相對來說會少點兒。不過，下面幾項內容必須有，這是我們使用接口中和測試接口的依據：
（1）接口名稱。標識各個接口的簡單說明，如登錄接口，獲取項目詳情接口等。
（2）接口URL。接口的調用地址，在測試環境下前面的域名可能不一樣，不過接口名是不會變的。
（3）調用方式。接口的調用方式：Post/Get方式，決定了如何調用接口及傳遞參數。
（4） 參數。接口需要傳遞的參數，參數需要增加些兒說明：
（a） 參數值類型說明：參數值要說明一下，只支持字母，數據，特殊字符或是字母數據混搭。
（b）參數長度說明：參數接收最大多少個的字符串，或是最大是多少的數值等。
（c） 參數取值范圍：像枚舉型的參數，只接收什么范圍內的數據，如1-5等。
（d）參數的配合說明：有些兒參數需要配合起作用的，如：offset和count參數。
（e） 參數是必需的還是非必需的。
（5）返回值。接口的返回值說明需要包含正確和錯誤的情況，正確的情況下有哪兒數據，錯誤的情況下會有什么提示？
（6）其他的一些兒說明。上面的說明是通用的，還有其他的一些兒說明，如必須是登錄狀態調用，或是版本號等說明，在某些兒情況下也需要說明一下。
嚴格要求的公司會要求接口開發人員標明上面相關的接口說明，此時我們做接口測試的時候，就可以參照文檔來轉化我們的測試用例。但目前國內很多公司不太注重文檔，接口信息不全是常有的事情。
7.3 接口文檔缺失
針對目前接口文檔信息不全或是沒有接口文檔的情況下，如果上面的領導要求我們做接口自動化測試，這無異是一個非常艱辛的任務。但是奉承着“兵來將當，水來土掩”的原則，我們要想着解決辦法。
（1）完全沒有接口文檔。這個情況是最麻煩的，我們要找開發人員來商量 ，最好能補個接口文檔，如果實在來不及那就給個調用接口的實例。實例中會有接口地址，參數等信息，我們去測試環境中調用一下，就能看到返回結果的情況。
（2）接口文檔信息不全。信息不全這個最常見，像參數說明缺少啊，沒有說明哪些兒是必需的參數，哪些兒是非必需的，或是沒有說明取值范圍等。此時我們能問開發就問開發，如果不太方便，就要做嘗試：一般非必需的參數不會做容錯的判斷，必需的參數檢測的方面比較全面。
（3）文檔不是最新的。接口的后續的工作中被修改或是優化過，我們按接口文檔上的說明去調用，返回和預期的不一樣。通知開發更新文檔，然后用最新的文檔再去修改測試用例。
這個接口文檔需要和接口開發人員做好約定，開發新接口時要把接口信息寫清楚，如果更新原來的接口，要及時更新接口文檔。同時在寫接口自動化測試用例的時候，要多和開發人員溝通，只有通過大家的一起努力，才能把工作做的越來越好。