feat(api): 添加代销平台 API 契约文档及相关更新
- 新增《接口契约-代销平台API-v0.1.md》,定义代销平台 REST API 的路由风格、命名规范及端点清单。 - 更新 AGENTS.md,包含代销平台 API 契约的路径信息。 - 修改 ITERATION.md 和 MEMORY.md,反映代销平台 API 的实施进度及相关文档的状态。 - 更新 TODO.md,明确代销平台 API 的实现优先级。 此更新为代销平台 API 的开发提供了清晰的指导,确保各模块间的接口一致性与可维护性。
This commit is contained in:
@@ -40,7 +40,7 @@
|
||||
| ② 数据交互矩阵 | `docs/需求拆解/数据交互矩阵.md` |
|
||||
| ③ 存储层 | `jinrong_core` / `jinrong_agent` · `docs/项目框架设计/表设计/` · Core 模拟底座 |
|
||||
| ④ 公共函数 | `app/repository/core_ro.py` · `app/model/suitability.py` · `scripts/sync/` |
|
||||
| ⑤ 公共 API | `app/api/auth.py` · `app/api/chat.py` · 规划中的 `app/api/platform/` |
|
||||
| ⑤ 公共 API | `app/api/auth.py` · **代销平台** `customers/products/advisors/compliance`(契约见《接口契约-代销平台API-v0.1》)· `simulate` · Agent 对话 `chat`(队友) |
|
||||
| ⑥ Agent | 各负责人 `app/service/agent_service.py` 及 Tool |
|
||||
|
||||
---
|
||||
@@ -118,20 +118,24 @@ P1/P2 → 联调提需求 → 补 Repository → 升 API v0.2+
|
||||
|
||||
### 5.3 Phase A 清单(与 `core_ro.py` 对齐)
|
||||
|
||||
| Repository 方法 | 建议 REST(草案) | 主要场景 |
|
||||
| --- | --- | --- |
|
||||
| `get_customer_l0` | `GET /api/customers/{id}` | C-01、A-01、仪表盘 |
|
||||
| `list_customers_by_advisor` | `GET /api/advisors/{id}/customers` | F-01、代理人仪表盘 |
|
||||
| `is_advisor_assigned` | 归属中间件 / 内 Service | F-01 |
|
||||
| `get_product` | `GET /api/products/{id}` | C-02、A-02 |
|
||||
| `get_latest_nav` | `GET /api/products/{id}/nav` | C-05 |
|
||||
| `list_holdings` | `GET /api/customers/{id}/holdings` | C-01、A-01 |
|
||||
| `list_trades` | `GET /api/customers/{id}/trades` | C-01、D-01、R-01 |
|
||||
| `list_products_for_customer` | `GET /api/customers/{id}/products` | C-11 |
|
||||
| `check_suitability` | `POST /api/compliance/suitability-check` | R-02 |
|
||||
| `get_staff` | `GET /api/staff/{id}` 或鉴权上下文 | F-01 |
|
||||
> **路由与命名权威文档:** [接口契约-代销平台API-v0.1.md](../项目框架设计/接口契约-代销平台API-v0.1.md)
|
||||
> **拍板(2026-09-08):** 路由 **A · 按业务域**;与 Agent 重复时 **以本平台 API 为准**;合并期统一命名。
|
||||
|
||||
> 正式字段、错误码、归属规则见后续 **《接口契约 v0.1》**(待 P1 单独出稿)。
|
||||
| Repository 方法 | Canonical REST | 主要场景 |
|
||||
| --- | --- | --- |
|
||||
| `get_customer_l0` | `GET /api/customers/{customer_id}` | C-01、A-01、仪表盘 |
|
||||
| `list_customers_by_advisor` | `GET /api/advisors/{advisor_id}/customers` | F-01、代理人仪表盘 |
|
||||
| `is_advisor_assigned` | 归属中间件 / 内 Service | F-01 |
|
||||
| `get_product` | `GET /api/products/{product_id}` | C-02、A-02 |
|
||||
| (待补)`list_products` | `GET /api/products` | 产品货架 |
|
||||
| `get_latest_nav` | `GET /api/products/{product_id}/nav` | C-05 |
|
||||
| `list_holdings` | `GET /api/customers/{customer_id}/holdings` | C-01、A-01 |
|
||||
| `list_trades` | `GET /api/customers/{customer_id}/trades` | C-01、D-01、R-01 |
|
||||
| `list_products_for_customer` | `GET /api/customers/{customer_id}/products` | C-11 |
|
||||
| `check_suitability` | `POST /api/compliance/suitability-check` | R-02(**取代** `/api/risk/suitability/check` 为 canonical) |
|
||||
| `get_staff` | `GET /api/staff/me` | F-01 |
|
||||
|
||||
> 正式字段、错误码、归属规则见 **《接口契约-代销平台API-v0.1》**。
|
||||
|
||||
---
|
||||
|
||||
@@ -178,3 +182,4 @@ Agent 对话能力走第 ⑥ 步,**不重复实现 L0 查数逻辑**。
|
||||
| --- | --- |
|
||||
| 2026-09-08 | 首版:固化「需求→矩阵→存储→Service→API→Agent」主线及分批策略 |
|
||||
| 2026-09-08 | AL-09 合并完成:`merger` 分支 502 绿;下一步统筹 Phase A Core REST API v0.1 |
|
||||
| 2026-09-08 | 代销平台 API 拍板:路由 A(业务域)· 重复功能以平台 API 为准 · 《接口契约-代销平台API-v0.1》 |
|
||||
|
||||
@@ -14,6 +14,7 @@
|
||||
| 2 | [02-项目开发计划.md](./02-项目开发计划.md) | 项目级 5 周计划:Wave×Phase 双视角、依赖链、周验收门、第1周天级、风险、答辩准备 | 每周初、里程碑评审 |
|
||||
| 3 | [03-表设计文档.md](./03-表设计文档.md) | 给人看的表设计字典:MySQL双库/Redis/Neo4j/Milvus 分层、谁写谁读、关键字段中文释义、建表顺序 | 写代码查表、联调对字段 |
|
||||
| 4 | [04-从需求到公共API开发方法.md](./04-从需求到公共API开发方法.md) | **方法论文档**:需求→矩阵→存储→Service→API→Agent 主线、分批策略、统筹分工、Phase A 接口清单 | 搭公共底座/API 前;新人 onboarding |
|
||||
| 5 | [../项目框架设计/接口契约-代销平台API-v0.1.md](../项目框架设计/接口契约-代销平台API-v0.1.md) | **代销平台 REST 契约**:业务域路由、命名规范、v0.1 端点、Agent 合并迁移表 | 写平台 API / Review Agent 重复接口 |
|
||||
|
||||
---
|
||||
|
||||
|
||||
Reference in New Issue
Block a user