大家在給甲方做大型項目的時候,有時候參與的廠商比較多,而公司負責的部分又需要第三方廠商提供接口支持。
例如我們做醫療行業的,給醫院提供醫保控費系統服務的,就需要HIS廠商提供接口給我們采集數據。有時候他們不理解你們提供的接口需求文檔,所以一些數據給錯了或者沒給到,也可能他們接口本來就開發錯了,還有一種可能就是我們的測試人員沒有按照HIS的要求進行測試使用導致,這個時候就需要他們積極的協助配合。
但是呢,有些通用接口已經開發好的不一定就你們公司使用,一旦修改的話可能影響了別的系統,所以HIS廠商一般不太樂意去幫你修改,尤其是當你提出的修改需求他們都聽不懂的時候,更不想費力去聽你講了。
這時候,一份詳細且又規范的文檔就顯得特別重要,我們可以設計一個文檔來盡可能詳細的描述我們發現的問題,是怎樣測試的時候發現的以及我們真正需要的是什么樣的數據,把這份文檔丟給他們,讓他們一看就能馬上定位問題,問題就很好解決了。
以下是我設計的關於接口測試問題向第三方廠商反饋並尋求積極配合處理的文檔模版(文末提供文檔下載地址):
本文檔是站在第三方技術人員的角度去思考他們需要什么信息來輔助他們定位問題
- 文檔說明解釋了為什么發這份文檔給他們
- 問題反饋記錄匯總記錄了所有可能存在問題的接口,因為有時候處理接口並不是一次性就能完善的,需要不斷的協調並進行修改,文檔的目的也是為了記錄我們處理接口問題的過程,做留檔。
- 接口地址用於說明我們測試這個接口的時候是用了這樣的url,可以讓第三方技術人員判斷我們是不是測錯接口了。
- 測試人員用於第三方技術人員直接於測試人員聯系並做出解釋。
- 測試時間記錄的測試發生的時間,方便他們查找日志文檔。
- 請求方式、請求頭部信息、請求參數可以讓第三方技術人員快速判斷測試人員是否按照接口要求進行測試,此外請求猜數也方便第三方技術人員自己測試進行問題復現。
- 響應狀態碼則直接告訴他們接口有沒有通。
- 實際返回值和預期返回值可以讓第三方技術人員進行對比我們想要得到什么樣的數據。
- 問題描述記錄我們發現什么問題以及希望解決什么樣的問題。
以上是我作為一個開發着的角度設計的文檔,至於有沒有用那就 見仁見智了,反正我要是第三方廠商看到這種文檔,我會盡可能積極配合。
每一個開發工程師都有一個共同點,那就是交卷不改,開發好的接口憑什么說改就改,且有時候一些需求的確是很過分的。
所以要想少跟開發工程師尤其是第三方的拉扯,你是不是該思考思考你的接口設計的是否合理?有些數據可以自行計算的是否應該自己去計算?有些數據在別的接口已經提供了是否可以利用起來?
另外,關於技術公司跨部門間溝通的問題,你可以閱讀這篇談“技術公司跨部門間溝通”問題及解決方案
或者是第三方API接口測試報告模版
文檔模版下載:百度雲盤:https://pan.baidu.com/s/1NZQLrCVmsZqIXgUApqvU1Q 提取碼:dppj