So-蔣民學
在微服務、前後端分離的架構模式下，絕大多數項目或多或少都會調用第三方API或者提供API給第三方調用。特別是我們自己作為API服務方時，API的設計規範很重要，一個設計良好的API要求具備語義性，一看就懂，簡潔明瞭。
API接口返回格式如何選擇？
API接口返回數據的格式有很多種，比如說：純文本、XML、JSON、二進制數據等。但從直觀性上說，因為返回的數據大多是結構化數據，所以XML和JSON格式返回較為直觀。
但從性能上考慮，JSON更輕量級，所以當前API返回數據格式幾乎99%是返回JSON字符串的。
API返回數據需要包含哪些元素？
1、CODE狀態碼
此狀態碼用來標識當前請求的狀態，這樣便於快速定位問題。可以參考HTTP狀態碼劃分一個數字段來表示特定的操作狀態，如：
200：正常
-
1000~1999：參數級錯誤
2000~2999：邏輯錯誤
3000~3999：代碼異常及錯誤
2、消息文本
此字段主要用於對錯誤的描述，正常響應時此字段為空，一旦有錯誤時會提示具體的錯誤原因。
3、數據結構體
此數據結構體就是調用方需要調用的數據，不同業務它所包含的字段不同。
以上就是我的觀點，對於這個問題大家是怎麼看待的呢？歡迎在下方評論區交流 ~ 我是科技領域創作者，十年互聯網從業經驗，歡迎關注我瞭解更多科技知識！網絡圈
返回狀態碼、狀態碼描述信息、數據。這樣調用者可以用狀態碼處理異常，描述消息展現給客戶或記錄日誌。
分享到:
