Back to Gin Vue Admin

前后端边界说明

aiDoc/frontend-backend/boundary.md

2.9.21.1 KB
Original Source

前后端边界说明

归属边界

  • 后端负责路由、参数校验、业务逻辑和响应结构
  • 前端负责页面流程、交互体验、本地状态和展示层
  • 共同行为通过明确的 API 契约协作,不通过隐式约定耦合

契约规则

  • 保持统一响应结构:{ code, data, msg }
  • 保持统一分页结构:{ page, pageSize, total, list }
  • 字段名不要随意漂移
  • 前后端字段类型必须保持一致
  • 后端必须提供完整而准确的 Swagger 接口说明
  • 前端接口调用应以实际 Swagger 与后端实现为准

变更规则

  • 涉及破坏性接口调整时,要先写清楚变更范围
  • Swagger 或其他接口说明必须与真实实现一致
  • 前端接口封装应继续放在 web/src/api/web/src/plugin/<name>/api/
  • 可复用逻辑优先复用 web/src/utils/ 现有能力

完成前检查

跨前后端改动结束前,至少确认以下几点:

  1. 后端响应结构仍然满足前端预期
  2. 前端仍在使用正确的字段名和数据类型
  3. 若契约发生了长期变化,对应说明已经补到 aiDoc/