docs: 清理过时文档,新增首页API契约并更新相关内容
- 删除backend-plan.md、backend-api-service.md等多份过时项目文档 - 新增home-api.md规范首页三类内容的Admin API补充契约 - 更新docs/README.md的文档清单与展示格式 - 优化integration-workflow.md、admin-api-requirements.md等文档的表格与内容 - 为WonderQ-MiniAPP的homeExperienceData.ts新增API适配类型与归一化函数
This commit is contained in:
@@ -4,11 +4,11 @@
|
||||
|
||||
## 三端职责
|
||||
|
||||
| 端 | 目录 | 职责 | 主要契约 |
|
||||
| --- | --- | --- | --- |
|
||||
| 后端 API | `WonderQ-Admin` | 提供 Public API、Admin API、鉴权、数据库、迁移和 seed | `backend-api-service.md`、`backend-plan.md`、`public-api.md`、`admin-api-requirements.md` |
|
||||
| 管理前端 | `WonderQ-Admin-UI` | 维护首页结构、目的地、线索和页面模块配置 | `admin-api-requirements.md`、`module-config-api.md` |
|
||||
| 前台 MiniAPP | `WonderQ-MiniAPP` | H5 与微信小程序前台展示、咨询和线索提交 | `public-api.md` |
|
||||
| 端 | 目录 | 职责 | 主要契约 |
|
||||
| ------------ | ------------------ | ----------------------------------------------------- | ----------------------------------------------------------------------------------------- |
|
||||
| 后端 API | `WonderQ-Admin` | 提供 Public API、Admin API、鉴权、数据库、迁移和 seed | `backend-api-service.md`、`backend-plan.md`、`public-api.md`、`admin-api-requirements.md` |
|
||||
| 管理前端 | `WonderQ-Admin-UI` | 维护首页结构、目的地、线索和页面模块配置 | `admin-api-requirements.md`、`module-config-api.md` |
|
||||
| 前台 MiniAPP | `WonderQ-MiniAPP` | H5 与微信小程序前台展示、咨询和线索提交 | `public-api.md` |
|
||||
|
||||
## 本地启动顺序
|
||||
|
||||
@@ -90,11 +90,9 @@ MiniAPP 联调重点:
|
||||
1. 先更新契约文档。
|
||||
- Public API 变更:更新 `public-api.md`。
|
||||
- Admin API 变更:更新 `admin-api-requirements.md`。
|
||||
- 页面模块 CRUD 变更:更新 `module-config-api.md`。
|
||||
2. 后端实现或调整接口,并补充对应验证。
|
||||
3. 管理前端或 MiniAPP 按契约调整调用和类型。
|
||||
4. 三端分别运行对应验证命令。
|
||||
5. 若变更影响启动、部署或架构边界,同步更新 `backend-api-service.md`、`backend-plan.md` 或 `decisions.md`。
|
||||
|
||||
## 验证命令
|
||||
|
||||
|
||||
Reference in New Issue
Block a user