關於和第三方介面聯調的一點經驗隨筆
在系統開發過程中,我們經常會涉及到和第三方服務聯調的過程。關於和第三方進行介面聯調,稍微說下自己的想法。
1. 介面文檔
介面文檔是我們了解第三方介面的基礎。通過介面文檔我們能大致了解每個介面的功能,調用的場景是什麼,調用時需要傳哪些欄位,調用過程中是否需要進行加解密等。所以在和第三方進行開發聯調前,你一定要問第三方要一份詳細的介面文檔。
2. 梳理介面文檔
拿到介面文檔後,你需要仔細閱讀介面文檔,下面的這些問題需要你重點關注。
- 第三方提供的介面是否能滿足你們自己的業務需求?假如提供的介面不能滿足你的業務需求,你需要讓對方補充介面,如果對方不能補充的,你就要考慮下其他方案,同時想下還有沒有和第三方繼續對接的需要;
- 理清楚第三方提供的每個介面的功能,弄清楚這些介面在你們的業務場景中的調用時機是什麼,最好能畫出一個流程圖或者時序圖,這樣會更加清楚;
- 確認下介面請求是否需要加解密操作,如果需要最好是讓對方提供一個加解密的demo,這樣會減少出錯的可能性,加快聯調速速;
- 確認對接過程中是否需要第三方為我們分配渠道號、產品程式碼、加解密秘鑰等這些固定參數,如果需要的話,提前向第三方申請,這樣也會加快開發進度;這些參數包括開發、測試和生產的,一般情況下生產的參數在聯調階段都給不出來,你可以記一個todo-list,以免上線時忘記;
- 確認第三方的介面調用地址,你們的系統是否能夠調得通,如果不通的話,你可能要提前通知你們的運維人員開通網路防火牆(包括測試和生產)
- 梳理介面的入參和返參,你要明確每個欄位的含義是什麼,怎麼傳,你們系統是否能提供這個欄位,返回參數哪些是你需要的,等等。
梳理介面階段你必須做完上面這些工作才算合格。不要覺得這些事情不重要,這些梳理工作能讓你提前發現很多問題。而等到開發聯調時才發現,可能會讓你的「手足無措」。
3. 開發聯調
雖然有介面文檔,但是由於種種問題,介面的實際運行和我們理解的總是有出入的。開發聯調階段就是驗證介面是否滿足介面文檔的描述。如果你的介面文檔梳理的很到位的話,開發聯調階段應該是非常輕鬆的。
這邊有個小建議:就是在調用第三方介面時,對於第三方系統拋出的異常不要處理,直接向上拋出,讓你們系統的業務程式碼處理。
4. 上線階段
當開發聯調完成後,就是要系統上線了。上線前我們應該要確認好下面的事情:
- 三方系統是否能支援我們的上線排期;
- 我們的系統和三方系統網路是否已經開通;
- 渠道號、產品程式碼、秘鑰這些參數生產環境是否配置正確;
確認完這些事情後上線一般就沒什麼大問題了。