ERPTurbo_Admin/.claude/rules/swagger-json.md
shenyifei 9001490da1 feat(dealer): 添加经销商应收账款功能并优化订单发货单相关组件
- 新增 DealerAccountRecordList 组件用于展示经销商应收账款记录
- 在 DealerList 中添加应收账款标签页和相关组件
- 为 OrderShipList 和 OrderShipModal 添加应收金额和调整金额列
- 新增 OrderSupplierSelectList 替代原有的 OrderSupplierInvoiceList
- 重构 ReconciliationSummary 使用 ProForm 组件并优化抹零功能
- 更新对账单创建页面逻辑,使用新的应收金额和调整金额字段
- 添加 ReceivablesDetail 页面用于查看应收账款明细
- 优化发货单选择列表的列配置和渲染方式
2026-01-09 18:04:49 +08:00

940 B

paths
swagger/*.json

规则:不要加载或修改 swagger/*.json 文件

规则说明

swagger/ 目录下的 JSON 文件是后端服务自动生成的 OpenAPI 规范文件,由后端团队维护。

禁止行为

  • 直接读取 swagger/*.json 文件
  • 修改 swagger/*.json 文件
  • 在前端代码中依赖这些文件
  • 将 swagger JSON 文件纳入版本控制(如需跟踪,应由后端处理)

正确做法

  1. 更新 API 类型:如需更新前端 API 类型定义,运行命令:

    cd packages/app-operation
    pnpm openapi
    
  2. 使用生成的 services:前端应使用 src/services/ 目录下自动生成的 API 客户端代码,而非直接解析 swagger 文件

违反此规则的后果

  • 可能导致前端与后端 API 不同步
  • 手动修改的 swagger 文件会在下次后端同步时被覆盖
  • 破坏前后端约定的 OpenAPI 规范