返回資料及返回編碼格式設計

整體設計

{
    "status": 404,
    "code": 40483,
    "message": "Oops! It looks like that file does not exist.",
    "url": "/errors/40483"
    "data":{
            "id": "ab473fb91021000",
            "email": "[email protected]",
            "contact": "songxx",
            "telephone": "15901288634"
 
,
            "qq": "12796694",
            "company": "北京魂世界資訊科技有限公司",
            "website": "http://soulgame.com/",
            "username": null,
            "password": null,
            "ackPassword": null
            }
}

組成元素

Status

狀態屬性在響應頭中僅僅是相同的HTTP狀態碼（整數）。這是一個方便的機制：通過在訊息體中包含狀態程式碼，任何處理錯誤的REST客戶端都只有一個地方可以完全理解錯誤：錯誤表示本身。不需要檢查標題值或其他位置來理解訊息。

Code

code是特定於REST API的錯誤程式碼。它傳達非常特定的問題域的資訊的東西。

由於僅有24個廣為人知的通用HTTP錯誤程式碼的限制，這是方便的。通過使用我們自己的程式碼，可以傳達更多具體和更豐富的理由，為什麼失敗。同樣，API客戶端可以接收的資訊越多越好。

在上面的例子中，code屬性的值是40483.雖然通用的“status”：404表示沒有找到請求的資源，但是也許有一個特定於應用程式的程式碼40483，它不僅表明資源沒有沒有找到,而且可以定位到具體哪個資源沒有找到.

Message

訊息屬性是一個很好的人類可讀的錯誤訊息,它應該是友好的，容易理解的，並傳達一個簡明的理由，為什麼發生錯誤.

Url

url屬性指定一個URL,就是正在呼叫的介面.

Data

後端返回給前端的資料.