系统开发实践 前后端交互规范

346 字
2 分钟
系统开发实践 前后端交互规范

经过团队内部讨论并达成一致, 前后端系统交互时, 我们遵循以下规范

后台响应报文规范#

{
"code": 200, // 200-正常返回, 401-未登录, 403-权限不足, 500-业务异常(或者服务器异常)
"data": {}, // 响应的数据
"errorCode": "", // 如果失败时, 会有对应的异常代码
"message": "" // 用于辅助信息提示
}

前端请求规范#

前端在向后端发送数据请求时, 必须在 header 中带入识别用户身份信息的 token, 请求报文上支持表单格式和 json 格式, http 请求方法上, 原则上查询请求使用 GET, 提交修改数据统一使用 POST

请求 header 头设计说明

字段名说明
token用户会话标识
user-id用户id, 用于 nginx 日志采集
ga-xxx一些特定的信息收集字段, 例如经纬度, 手机型号等等
timestamp请求时间搓
app-versionapp版本号

分页数据请求规范#

{
"pageNum": 1, // 分页页码
"pageSize": 200, // 分页大小
"condition1": "aaa", // 搜索条件1
"condition2": "bbb", // 搜索条件2
"condition3": "ccc", // 搜索条件3
"sort": {
"field": "", // 排序字段
"order": "asc" // 升序降序
}
}

分页数据响应规范#

{
"code": 200,
"data": {
"pageNum": 1, // 分页页码
"pageSize": 200, // 分页大小
"total": 1000, // 数据总量
"content": [{},{}] // 分页数据
}

文章分享

如果这篇文章对你有帮助,欢迎分享给更多人!

系统开发实践 前后端交互规范
https://blog.sephy.top/posts/system-development-practice-frontend-backend-interaction-guidelines/
作者
虾米
发布于
2017-11-01
许可协议
CC BY-NC-SA 4.0

评论区

Profile Image of the Author
虾米
coder
分类
标签
最新动态

还没有发布动态

更多动态
站点统计
文章
63
动态
0
分类
5
标签
57
总字数
67,972
运行时长
0
最后活动
0 天前
站点信息
构建平台
GitHub Actions
博客版本
Firefly v6.14.2
文章许可
CC BY-NC-SA 4.0