搭建相親交友原始碼 ，API 介面統一格式返回的實現

前後端介面  互動

我們都知道，相親交友原始碼前端通常會通過後臺提供的介面來獲取資料來完成前端頁面的渲染，所以在相親交友原始碼開發時，要做好API介面的設計，以實現更好的效果。

相親交友原始碼 API 介面返回值約定

返回值規範

• 設定返回的 HTTP 響應狀態碼；
• 相親交友原始碼發生錯誤時，需設定 Response Body 的錯誤碼和描述資訊；

正確返回

HTTP 響應狀態碼，設定成 200，Response Body 結構為返回的資料結構。

錯誤返回

HTTP 響應狀態碼，不要設定成 200！需遵循 RFC 標準。

// Failure 錯誤時返回結構
type Failure struct {
    Code    int    `json:"code"`    // 業務碼
    Message string `json:"message"` // 描述資訊
}

統一定義錯誤碼

錯誤碼規範

• 統一在相親交友原始碼一個檔案中定義錯誤碼；
• 錯誤碼長度為 5 位；

第 1 位表示錯誤是哪種級別？例如：1 為相親交友原始碼系統級錯誤，2 為相親交友原始碼業務模組錯誤，可標記 9 種錯誤級別。

第 2 位和第 3 位表示錯誤是哪個模組？例如：01 為相親交友原始碼使用者模組，02 為訂單模組，可標記 99 個模組。

第 4 位和第 5 為表示具體是什麼錯誤？例如：01 為手機號不合法，02 為驗證碼輸入錯誤，可標記 99 個錯誤。

Controller 層如何用？

正確返回

res := new(createResponse)
res.Id = 1
ctx.Payload(res)

錯誤返回

c.AbortWithError(errno.NewError(
    http.StatusBadRequest,
    code.AdminCreateError,
    code.Text(code.AdminCreateError)).WithErr(err),
)
return

總結

以上便是“如何實現相親交友原始碼 API 介面的統一格式返回？”的全部內容，其實還有很多的優化空間，希望能給搭建開發相親交友原始碼提供幫助。

本文轉載自網路，轉載僅為分享乾貨知識，如有侵權歡迎聯絡雲豹科技進行刪除處理
原文連結：