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

lindroid 发布于2019-08-19 10:25 / 2771人阅读

摘要：一前后端接口设计前后端接口设计主要考虑以下几点二接口内容接口内容包括鉴权信息，如用于身份识别的。公共信息，例如用户，项目等需要传给后端的公共数据。

一、前后端接口设计

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

二、接口内容

接口内容包括：

鉴权信息，如用于身份识别的token。

公共信息，例如用户ID，项目ID等需要传给后端的公共数据。

错误信息，如错误码，错误描述。

业务数据，业务使用到的数据，如订单，产品。

三、数据承载

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

{
    resultCode,  --标识成功还是失败
    errorCode,
    errorMsg,
    domainObject
}

四、数据格式

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

五、异常约定

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

end.

站点： http://javashizhan.com/

微信公众号：

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

服务器托管私有云服务端接口api 服务器端接口怎么写服务器端接口测试i 基础篇

文章版权归作者所有，未经允许请勿转载,若此文章存在违规行为，您可以联系管理员删除。

转载请注明本文地址：https://www.ucloud.cn/yun/76004.html

迈出全栈第一步，vue+node+mysql独立完成前后端分离的增删改查流程

摘要：本使用创建本地服务器，在就能完成全部流程，并不需要线上服务器。路径要与后端接口一致。后端返回成功后，前端数据中对应的元素也要删掉，更新视图。控制器里拿一个方法出来说一下吧，完整的代码都在。读取操作完成后调用释放连接。写在前面本文只是本人学习过程的一个记录，并不是什么非常严谨的教程，希望和大家一起共同进步。也希望大家能指出我的问题。适合有一定基础，志在全栈的前端初学者学习，从点击按钮...

fsmStudy 2019-08-20 16:10 评论0 收藏0
FEer到全栈开发

摘要：代码开发记得曾经听开发平台的同学骄傲的讲，中只有百度有全公司级别的统一代码仓库，并且使用管理代码，不明觉厉，我也很骄傲。前言从前，一个类B/S架构的应用里，FEer，或者叫切图仔，切图+表单验证就是工作的全部。无奈我所做的全部，只是整个应用的冰山一角...责任小了，边缘感就强了，owner意识自然差，视野自然受限。感谢V8引擎的极速体验&chrome浏览器的紧随规范，js执行速度...

elina 2019-08-20 18:14 评论0 收藏0
Web全栈应用之旅-基础篇（二）异常设计

摘要：异常堆栈开发过程中，不可避免的会有未考虑的异常场景，堆栈信息可以帮助快速解决故障。异常日志有时候需要借助异常堆栈信息定位错误原因，而用户未必能记得和反馈错误堆栈信息，此时要么是自行复现错误来定位，要么是通过历史错误日志定位。一、异常设计异常设计主要考虑以下方面： showImg(https://segmentfault.com/img/bVbwdua?w=1624&h=867);...

MudOnTire 2019-08-19 10:26 评论0 收藏0