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