系统开发实践 前后端交互规范
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-version | app版本号 |
分页数据请求规范
{ "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": [{},{}] // 分页数据}文章分享
如果这篇文章对你有帮助,欢迎分享给更多人!
相关文章智能推荐
1
系统开发实践 Spring Cloud 异常封装及传递处理
编程准备将 RPC 协议从 dubbo 切换为 feign, 记录一些系统设计细节
服务端的异常输出设计
OpenFeign 的异常传递捕捉处理
2
重新认识 .gitignore:目录级规则与 .git/info/exclude
编程从目录级 .gitignore 的作用域、匹配优先级和常见陷阱出发,理解 Git 的忽略机制,并掌握 .git/info/exclude 的使用方法。
3
从 cc-connect 看 Codex CLI 的交互模式:stdin、stdio 与 HTTP
AI以 cc-connect 调用 Codex CLI 为例,拆解 exec、app-server、stdin/stdout 和 JSON-RPC,再和 HTTP 的通信模型做对照。
4
把 MCPHub 部署在 Homelab 上:统一管理 MCP 服务的实际体验
AI记录我把 Linear、Cloudflare、Bytebase 等 MCP 服务集中部署到 Homelab 后,解决多设备重复配置、token 分散和 MCP 地址过多问题的实际体验。
5
企业为什么需要 MCPHub:从统一接入到工具治理
企业AI从 MCP 服务集中接入、凭据治理、分组授权、监控审计和运维边界出发,讨论 MCPHub 在企业 AI 工具治理中的实际价值与局限。
随机文章随机推荐
