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

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/系统开发实践-前后端交互规范/
作者
虾米
发布于
2017-11-01
许可协议
CC BY-NC-SA 4.0
相关文章智能推荐
1
系统开发实践-Spring Cloud 异常封装及传递处理
技术分享准备将 RPC 协议从 dubbo 切换为 feign, 记录一些系统设计细节 服务端的异常输出设计 OpenFeign 的异常传递捕捉处理
2
在 PVE 上给软路由虚拟机加一个网络 Watchdog
技术分享在 PVE 宿主机上用 Bash 和 systemd timer 实现一个网络 watchdog:先检测公网连通性,连续失败后重启软路由虚拟机,多次自愈无效再升级为重启 PVE 宿主机。
3
命令行自动登录 JumpServer:SSH、TOTP 与密码提示的自动化
技术分享把 JumpServer 登录流程拆成凭据读取和终端交互两层:zsh 从密码管理器安全读取 TOTP seed 与可选密码,expect 只负责响应 SSH 登录过程中的 password 和 Code 提示。
4
git 个人开发工作流
技术分享介绍个人 Git 分支协作流程:以基线分支(如 feature-a)+ 个人开发分支(feature-a-xxx)进行开发,开发分支定期 rebase 同步上游,最终通过 merge(必要时先 squash 整理提交)合回基线;并提供 grebase/gmergebase 等脚本,支持自动推导基线分支、预览计划、带 autostash 的安全 rebase,以及可选 squash/推送/删除分支的安全 merge-back。
5
DDD记录
方法论这篇文章讨论了在 充血模型 和 贫血模型 之间找到平衡点,强调在实践中可以适当妥协。通过 DDD 中的 聚合根 和 领域服务 思想,减少不必要的服务类,简化设计,同时借鉴 CQRS 来优化查询逻辑。文章建议,尽管充血模型增加复杂度,但可以通过适度的领域服务管理和领域事件来达到合理的业务处理和开发效率。
随机文章随机推荐
Profile Image of the Author
虾米
coder
分类
标签
站点统计
文章
61
分类
4
标签
52
总字数
64,663
运行时长
0
最后活动
0 天前
站点信息
构建平台
GitHub Actions
博客版本
Firefly v6.13.9
文章许可
CC BY-NC-SA 4.0