最近做了好幾個項目的接口自動化,接口測試很重要的參考依據就是接口文檔,在自動化實施過程中碰到的接口文檔也是千差萬別,有的項目沒有接口文檔,有的項目有接口文檔,有接口文檔的項目,有的很完善,有的不完善,有的沒有和項目迭代保持最新,一直也沒有對文檔這一塊做一個總結,導致工作中很容易發生漏測的情況。我們為什么要提這個接口文檔呢,首先從開發角度,有了接口文檔,各個模塊之間的開發才能更清楚的知道對方的接口是如何定義和調用的,并且新入職或新接手的開發能快速的上手這個接口,具有指導意義。

其次從測試角度,有了接口文檔,測試才知道如何去調用,如何去傳參,如何設計用例來驗證結果的正確性,不然靠口口相傳,一方面溝通的成本會很大,很浪費時間,另一方面不能保證在口頭交流過程中漏掉一些東西,導致最終質量上出現缺陷,可見接口文檔是多么的重要。因為公司崗位的特殊性,我們項目目前針對接口文檔是這樣做的:

用的軟件導出圖片額度沒了,先截圖了,不清晰,大概看吧,從上面的圖中可以看出,接口文檔的提供具有一定的主觀性,有些隨意,不規范,也沒有一定的約束,所以要想保證接口文檔的有效性和規范性,首先應該從流程規范上面去約束,雖然google測試之道不推薦強流程和教條式的測試,但是國內目前的環境和大多技術人員的意識還沒有達到像google那樣的境界,沒有流程規范,就不會自覺的去執行,久而久之,便會不了了之。那么怎么從流程規范上面去約束呢,我目前想到的一個是評審階段,一個是提測階段,一個是總結報告階段,一個是上線階段,順序是:

  • 評審階段

在設計評審和代碼評審的時候,就確認接口文檔是否可用,是否完善,如果不完善,需要在評審結果中指明,補充完善接口文檔。

  • 提測階段

接口測試人員檢查在提測文檔中是否包含了接口文檔,并檢查文檔的可讀性以及有效性,如果沒有接口文檔或者可讀性極差,則打回提測,待補充完善后重新提測。

  • 總結報告階段

測試結束后,對本次測試過程中,接口文檔的規范性做一個報告,如果接口文檔在提測之前沒有規范,則在報告中體現出來,并@各方引起重視

  • 上線階段

這個階段是產品的最終階段,不建議立馬作為一個流程環節,建議是先做好前面三個階段的工作后,磨合期已過,各個項目已經適應了前三個階段,并可以按時提供規范的接口文檔后,該階段再拿出來作為一個審核流程環節,就是如果上線申請中沒有接口文檔,則不予上線。最后的階段是我們的目標,所以我們在推廣流程的前期,就要把目標給說出來,說明下最終目標的嚴重性,并且流程的推廣一定要是職位級別從上往下傳達。