logo头像
书院的十三先生

Web全栈应用之旅-基础篇(一)前后端接口

一、前后端接口设计

前后端接口设计主要考虑以下几点:

二、接口内容

接口内容包括:

  1. 鉴权信息,如用于身份识别的token。
  2. 公共信息,例如用户ID,项目ID等需要传给后端的公共数据。
  3. 错误信息,如错误码,错误描述。
  4. 业务数据,业务使用到的数据,如订单,产品。

三、数据承载

数据承载指接口数据是放到HTTP消息头还是HTTP消息体当中,一些公共的信息如鉴权token,用户ID,项目ID可以考虑放到消息头中,应答消息,业务数据,异常可以考虑放到消息体中。
按照这个原则,可设计一个公共的应答对象:

1
2
3
4
5
6
{
resultCode, --标识成功还是失败
errorCode,
errorMsg,
domainObject
}

四、数据格式

JSON格式容易阅读,并且从字符串到对象的转换很方便,因此基本上数据格式非它莫属。

五、异常约定

异常约定主要考虑以何种方式告知前端异常?例如是通过HTTP状态码告知还是通过接口对象返回的结果码告知,HTTP状态码方式的好处是监控异常比较方便,直接可以取到状态码,而接口对象返回的结果码则还需要解析。
个人觉得都可以,只要约定好就行。

end.


站点: http://javashizhan.com/


微信公众号:


加入知识星球,参与讨论,更多实战代码分享!
https://t.zsxq.com/RNzfi2j