|
|
|
@ -343,8 +343,6 @@
|
|
|
|
| 4 | `/api/admin/worker/list` | GET | `/mock-api/admin/worker/list` | 设备管理、产量报表 |
|
|
|
|
| 4 | `/api/admin/worker/list` | GET | `/mock-api/admin/worker/list` | 设备管理、产量报表 |
|
|
|
|
| 5 | `/api/admin/collect-address/list` | GET | `/mock-api/admin/collect-address/list` | 设备管理 |
|
|
|
|
| 5 | `/api/admin/collect-address/list` | GET | `/mock-api/admin/collect-address/list` | 设备管理 |
|
|
|
|
|
|
|
|
|
|
|
|
> 返回格式统一为 `{ "code": 0, "data": { "items": [...] } }`,只包含 id 和名称字段,不含分页。
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
|
|
## 四、端点汇总
|
|
|
|
## 四、端点汇总
|
|
|
|
@ -379,9 +377,10 @@
|
|
|
|
|
|
|
|
|
|
|
|
**Mock不动规则(限定为返回数据结构)**:
|
|
|
|
**Mock不动规则(限定为返回数据结构)**:
|
|
|
|
|
|
|
|
|
|
|
|
1. **返回数据结构不动**:正式 API 返回的 `data` 内部 JSON 结构(字段名、嵌套关系、items包裹等)必须与 Mock 保持一致。这是前后端联调的基础。
|
|
|
|
1. **返回数据结构不动**:正式 API 返回的 `data` 内部 JSON 结构(字段名、嵌套关系、items包裹等)必须与页面文件§9(接口引用与数据结构)中定义的数据结构保持一致。Mock 文件按页面文件§9生成,后端也必须对齐§9的数据结构。
|
|
|
|
2. **URL路径和HTTP方法按RESTful**:正式 API 的 URL 路径和 HTTP 方法使用 §1.3 定义的 RESTful 风格,不必与 Mock 的 URL 路径和方法完全一致。
|
|
|
|
2. **URL路径和HTTP方法按RESTful**:正式 API 的 URL 路径和 HTTP 方法使用 §1.3 定义的 RESTful 风格,不必与 Mock 的 URL 路径和方法完全一致。
|
|
|
|
3. **端点清单是唯一合同**:每个模块的端点清单(§3.1~3.13)同时列出了"正式API"和"Mock URL"两列,两边各自按自己的列实现/调用即可。
|
|
|
|
3. **端点清单是路由合同**:每个模块的端点清单(§3.1~3.13)同时列出了"正式API"和"Mock URL"两列,两边各自按自己的列实现/调用即可。端点清单只定义URL和方法,不定义返回数据结构。
|
|
|
|
|
|
|
|
4. **数据结构定义在页面文件§9**:每个接口的具体Request/Response数据结构由对应的页面文件§9(接口引用与数据结构)定义,这是数据结构的唯一来源。
|
|
|
|
|
|
|
|
|
|
|
|
**两列URL差异说明**:
|
|
|
|
**两列URL差异说明**:
|
|
|
|
- 写操作:Mock 用 `POST /xxx/update`、`POST /xxx/delete`,正式API 用 `PUT /xxx/{id}`、`DELETE /xxx/{id}`
|
|
|
|
- 写操作:Mock 用 `POST /xxx/update`、`POST /xxx/delete`,正式API 用 `PUT /xxx/{id}`、`DELETE /xxx/{id}`
|
|
|
|
@ -392,7 +391,8 @@
|
|
|
|
**新增或变更接口时的流程**:
|
|
|
|
**新增或变更接口时的流程**:
|
|
|
|
|
|
|
|
|
|
|
|
1. 先在对应模块的端点清单(§3.x)中**同时新增两行**:正式API列(RESTful)+ Mock URL列(POST简化)
|
|
|
|
1. 先在对应模块的端点清单(§3.x)中**同时新增两行**:正式API列(RESTful)+ Mock URL列(POST简化)
|
|
|
|
2. 在对应模块的 Mock 文件(`frontend/mock/*.ts`)中按 Mock URL 列新增 Mock 数据
|
|
|
|
2. 在对应模块的页面文件§9中定义该接口的Request/Response数据结构
|
|
|
|
3. 后端按正式API列实现接口,返回数据结构对齐 Mock 中定义的 JSON
|
|
|
|
3. 在对应模块的 Mock 文件(`frontend/mock/*.ts`)中按页面文件§9的数据结构生成 Mock 数据
|
|
|
|
4. 前端 Mock 开发时按 Mock URL 列调用,正式联调时切换到正式API列
|
|
|
|
4. 后端按正式API列实现接口,返回数据结构严格对齐页面文件§9的定义
|
|
|
|
5. 禁止只新增一列而遗漏另一列——每次新增接口必须两列同时更新
|
|
|
|
5. 前端 Mock 开发时按 Mock URL 列调用,正式联调时切换到正式API列
|
|
|
|
|
|
|
|
6. 禁止只新增一列而遗漏另一列——每次新增接口必须两列同时更新
|
|
|
|
|