浏览代码

docs(story-008.002): 更新故事任务,添加渠道模块RPC API调用信息

基于渠道模块集成测试文件,更新故事任务中的RPC API调用信息:
1. 任务3:添加具体的RPC调用方式和API路径映射
2. 任务7:添加基于集成测试和路由定义的验证点
3. Dev Notes:添加完整的RPC API调用信息、API路径映射和Schema字段定义

Generated with [Claude Code](https://claude.ai/code)
via [Happy](https://happy.engineering)

Co-Authored-By: Claude <noreply@anthropic.com>
Co-Authored-By: Happy <yesreply@happy.engineering>
yourname 2 周之前
父节点
当前提交
298ae5cbda
共有 1 个文件被更改,包括 56 次插入0 次删除
  1. 56 0
      docs/stories/008.002.transplant-channel-management-ui.story.md

+ 56 - 0
docs/stories/008.002.transplant-channel-management-ui.story.md

@@ -47,6 +47,22 @@ Draft
   - [ ] 实现ClientManager单例模式
   - [ ] 导出channelClient和channelClientManager
   - [ ] 创建API导出文件:`src/api/index.ts`
+  - [ ] **RPC API调用实现(基于渠道模块集成测试)**:
+    - [ ] 创建渠道:`client.createChannel.$post({ json: channelData })`
+    - [ ] 删除渠道:`client.deleteChannel.$post({ json: { id } })`
+    - [ ] 更新渠道:`client.updateChannel.$post({ json: channelData })`
+    - [ ] 获取渠道列表:`client.channels.$get({ query: { page, pageSize, name } })`
+    - [ ] 获取渠道详情:`client.channel[':id'].$get({ param: { id } })`
+    - [ ] 搜索渠道:`client.searchChannel.$post({ json: { name } })`
+    - [ ] 批量删除渠道:`client.batchDeleteChannel.$post({ json: { ids } })`
+  - [ ] **API路径映射(基于渠道模块路由定义)**:
+    - [ ] `POST /createChannel` → `client.createChannel.$post`
+    - [ ] `POST /deleteChannel` → `client.deleteChannel.$post`
+    - [ ] `POST /updateChannel` → `client.updateChannel.$post`
+    - [ ] `GET /channels` → `client.channels.$get`
+    - [ ] `GET /channel/:id` → `client.channel[':id'].$get`
+    - [ ] `POST /searchChannel` → `client.searchChannel.$post`
+    - [ ] `POST /batchDeleteChannel` → `client.batchDeleteChannel.$post`
 
 - [ ] 任务4:实现类型定义 (AC: 3, 8)
   - [ ] 参考对照文件:`allin-packages/platform-management-ui/src/api/types.ts`
@@ -73,6 +89,18 @@ Draft
   - [ ] 检查后端模块集成测试:`allin-packages/channel-module/tests/integration/`目录
   - [ ] 确保API路径一致性(基于故事008.001经验:不能假设为标准CRUD模式)
   - [ ] 验证Schema设计一致性(基于故事008.001经验:必须查看后端模块的集成测试和路由定义)
+  - [ ] **基于渠道模块集成测试的验证点**:
+    - [ ] 验证`CreateChannelSchema`字段:`name`(渠道名称)、`description`(描述)、`status`(状态)
+    - [ ] 验证`UpdateChannelSchema`字段:`id`(渠道ID)、`name`(渠道名称)、`description`(描述)、`status`(状态)
+    - [ ] 验证`DeleteChannelSchema`字段:`id`(渠道ID)
+    - [ ] 验证`SearchChannelSchema`字段:`name`(渠道名称)
+    - [ ] 验证`BatchDeleteChannelSchema`字段:`ids`(渠道ID数组)
+    - [ ] 验证`GetChannelListSchema`字段:`page`(页码)、`pageSize`(每页数量)、`name`(渠道名称)
+    - [ ] 验证`GetChannelDetailSchema`字段:`id`(渠道ID)
+  - [ ] **基于渠道模块路由定义的验证点**:
+    - [ ] 验证路由路径:`POST /createChannel`、`POST /deleteChannel`、`POST /updateChannel`、`GET /channels`、`GET /channel/:id`、`POST /searchChannel`、`POST /batchDeleteChannel`
+    - [ ] 验证路由处理函数:`createChannel`、`deleteChannel`、`updateChannel`、`getChannelList`、`getChannelDetail`、`searchChannel`、`batchDeleteChannel`
+    - [ ] 验证路由Schema引用:确保前端Schema与后端Schema定义一致
 
 - [ ] 任务8:运行测试和类型检查 (AC: 8)
   - [ ] 运行组件测试:`pnpm test`
@@ -108,6 +136,34 @@ Draft
   - `allin-packages/platform-management-ui/src/api/types.ts`
   - `allin-packages/platform-management-ui/tests/integration/platform.integration.test.tsx`
 
+### 渠道模块RPC API调用信息(基于集成测试)
+- **RPC客户端调用方式**(来自`allin-packages/channel-module/tests/integration/channel.integration.test.ts`):
+  - `client.createChannel.$post({ json: channelData })` - 创建渠道
+  - `client.deleteChannel.$post({ json: { id } })` - 删除渠道
+  - `client.updateChannel.$post({ json: channelData })` - 更新渠道
+  - `client.channels.$get({ query: { page, pageSize, name } })` - 获取渠道列表
+  - `client.channel[':id'].$get({ param: { id } })` - 获取渠道详情
+  - `client.searchChannel.$post({ json: { name } })` - 搜索渠道
+  - `client.batchDeleteChannel.$post({ json: { ids } })` - 批量删除渠道
+
+- **API路径映射**(来自`allin-packages/channel-module/src/routes/channel-custom.routes.ts`):
+  - `POST /createChannel` → `client.createChannel.$post`
+  - `POST /deleteChannel` → `client.deleteChannel.$post`
+  - `POST /updateChannel` → `client.updateChannel.$post`
+  - `GET /channels` → `client.channels.$get`
+  - `GET /channel/:id` → `client.channel[':id'].$get`
+  - `POST /searchChannel` → `client.searchChannel.$post`
+  - `POST /batchDeleteChannel` → `client.batchDeleteChannel.$post`
+
+- **Schema字段定义**(来自`allin-packages/channel-module/src/schemas/channel.schema.ts`):
+  - `CreateChannelSchema`:`name`(渠道名称)、`description`(描述)、`status`(状态)
+  - `UpdateChannelSchema`:`id`(渠道ID)、`name`(渠道名称)、`description`(描述)、`status`(状态)
+  - `DeleteChannelSchema`:`id`(渠道ID)
+  - `SearchChannelSchema`:`name`(渠道名称)
+  - `BatchDeleteChannelSchema`:`ids`(渠道ID数组)
+  - `GetChannelListSchema`:`page`(页码)、`pageSize`(每页数量)、`name`(渠道名称)
+  - `GetChannelDetailSchema`:`id`(渠道ID)
+
 ### 后端模块集成验证点
 - **路由定义**:检查`allin-packages/channel-module/src/routes/`目录中的实际路由
 - **集成测试**:检查`allin-packages/channel-module/tests/integration/`目录中的测试用例