好的收款介面及相應的說明文件

2021-07-14 17:45:36 字數 810 閱讀 7916

介面作用描述

描述這個收款支付介面的一般使用場景,給閱讀者乙個整體概念。

整體呼叫過程描述

描述這個收款支付介面的在各種情況下如何呼叫其他相關後續介面。比如收款檢測介面,退款介面等

輸入引數作用描述

描述這個收款介面所有輸入引數的要求和作用。

不同場景輸入引數舉例

對不同場景下輸入引數的舉例,讓閱讀者有直觀認識。

返回引數完整,說明清晰

描述這個介面的所有返回引數的作用,並且保證返回引數能夠滿足所有業務方的需要。

返回結果判定依據清晰

根據返回引數能夠清晰準確地判斷當前支付請求的狀態。

錯誤碼表完整,說明清晰

有完整的錯誤碼及相應描述,既便於呼叫方能夠根據錯誤碼進行相應的後續處理,還能提高對接開發效率。

有相應支付檢測介面

有支付檢測介面可以隨時查詢當前支付請求的狀態

有**demo供參考

降低開發者的入門難度,提高對接開發效率。

收款檢測介面及相應的說明文件應該包含以下幾個方面:

輸入引數完整

檢測的輸入引數支援使用商戶訂單號及第三方訂單號

返回引數完整,說明清晰

描述這個介面的所有返回引數的作用,並且保證返回引數能夠滿足所有業務方的需要。

返回結果判定依據清晰

根據返回引數能夠清晰準確地判斷當前支付請求的狀態。

錯誤碼表完整,說明清晰

有完整的錯誤碼及相應描述,既便於呼叫方能夠根據錯誤碼進行相應的後續處理,還能提高對接開發效率。

有**demo供參考

降低開發者的入門難度,提高對接開發效率。

git的詳細說明文件

git status 檢視更改的檔案 git diff 檢視更改檔案細節 git reflog 檢視所有的提交記錄 比較兩個分支然後打成補丁 git diff 分支1 分支2 補丁名稱 commit回滾到上一次操作 git reset soft head 撤銷某一次提交 git revert git...

四種發現協議的說明文件

snmp telnet telnet協議是tcp ip協議族中的一員,是internet遠端登陸服務的標準協議和主要方式。它為使用者提供了在本地計算機上完成遠端主機工作的能力。在終端使用者的電腦上使用telnet程式,用它連線到伺服器。終端使用者可以在telnet程式中輸入命令,這些命令會在伺服器上...

python中自定義函式的說明文件

help 該函式用於檢視函式或模組用途的詳細說明。help語法 help object help len 檢視len 的幫助資訊 len為python內建函式 python已經為該函式建立了文件說明 很多時候,需要自己建立函式的文件說明,這樣也方便讀懂自己的 自定義乙個函式 def sum 2 nu...