搜尋

首頁  >  問答  >  主體

angular.js - 設計 API 介面回傳的 JSON 資料格式有沒有比較流行的最佳實務?

最近我們公司開發一個項目, PC 端 手機 APP 端 手機網頁端 設計 API 介面返回的 JSON 資料格式有沒有比較流行的最佳實踐?

目前找了以下幾個版本

版本 1 : 成功執行: head Status Code:2XX

json {"id":51,"age":58,"name":"lifei"}

失敗執行 head Status Code:4XX-5XX {"message":"xxxxxx 錯誤","errors:{}}

版本 2 : 成功與失敗執行 head Status Code:2xx

json {"code":"0","message:"訊息","data":{}}

版本 3: 成功執行: head Status Code:2XX

json {"id":51,"age":58,"name":"lifei"}

失敗執行 head Status Code:4XX-5XX {"code":10001, "message":"xxxxxx 錯誤","errors:{}}

如果業務不同的錯誤類型,例如我要提現操作,可能會出現銀行卡未綁定、沒有上傳戶口本,沒有上傳身分證,沒有綁定手機號碼,沒有填寫住址等錯誤,沒有餘額等等。

phpcn_u1582phpcn_u15822744 天前582

全部回覆(4)我來回復

  • phpcn_u1582

    phpcn_u15822017-05-15 17:07:02

    這種
    http://swagger.io/

    回覆
    0
  • 巴扎黑

    巴扎黑2017-05-15 17:07:02

    http://jsonapi.org/

    https://github.com/interagent...

    這種規範都比較複雜,但是學一次終身受用,而且前端和後端都可以很方便復用

    自己定義規範優勢就是簡單,但是很多細節問題可能設計的時候考慮不到,修改起來很麻煩

    回覆
    0
  • 巴扎黑

    巴扎黑2017-05-15 17:07:02

    https://github.com/ShuyunXIAN...

    回覆
    0
  • 为情所困

    为情所困2017-05-15 17:07:02

    JSON RPC 2.0
    http://www.jsonrpc.org/specif...

    回覆
    0
  • 取消回覆