Web全棧應用之旅-基礎篇（一）先後端接口

1、先後端接口設計

先後端接口設計主要考慮如下幾點：

2、接口內容

接口內容包括：

1. 鑑權信息，如用於身份識別的token。
2. 公共信息，例如用戶ID，項目ID等須要傳給後端的公共數據。
3. 錯誤信息，如錯誤碼，錯誤描述。
4. 業務數據，業務使用到的數據，如訂單，產品。

3、數據承載

數據承載指接口數據是放到HTTP消息頭仍是HTTP消息體當中，一些公共的信息如鑑權token，用戶ID，項目ID能夠考慮放到消息頭中，應答消息，業務數據，異常能夠考慮放到消息體中。
按照這個原則，可設計一個公共的應答對象：

{
    resultCode,  --標識成功仍是失敗
    errorCode,
    errorMsg,
    domainObject
}

4、數據格式

JSON格式容易閱讀，而且從字符串到對象的轉換很方便，所以基本上數據格式非它莫屬。

5、異常約定

異常約定主要考慮以何種方式告知前端異常？例如是經過HTTP狀態碼告知仍是經過接口對象返回的結果碼告知，HTTP狀態碼方式的好處是監控異常比較方便，直接能夠取到狀態碼，而接口對象返回的結果碼則還須要解析。
我的以爲均可以，只要約定好就行。

end.

---

站點： http://javashizhan.com/

---

微信公衆號：

---

加入知識星球，參與討論，更多實戰代碼分享！
https://t.zsxq.com/RNzfi2j