feat: PLANNING体系首版(00路线图/02任务总表/03执行协议/I-03/I-04/registry42口径)+M1止血交付
This commit is contained in:
@@ -0,0 +1,31 @@
|
||||
# Checklist
|
||||
|
||||
## 功能验证
|
||||
- [x] 访问 `/api-detail/baidu-translate` 能正确显示详情页(通过客户端路由)
|
||||
- [x] 从API接口大全点击百度翻译卡片能跳转到详情页(路由映射已更新)
|
||||
- [x] 文档标签显示四个子接口的文档信息
|
||||
- [x] 测试标签能正常发送请求并显示响应
|
||||
- [x] 使用量统计正确显示
|
||||
|
||||
## 文档标签验证
|
||||
- [x] 文本翻译子接口显示正确的请求方法、URL、参数说明和响应示例
|
||||
- [x] 语种识别子接口显示正确的请求方法、URL、参数说明和响应示例
|
||||
- [x] 图片翻译子接口显示正确的请求方法、URL、参数说明和响应示例
|
||||
- [x] 语音翻译子接口显示正确的请求方法、URL、参数说明和响应示例
|
||||
|
||||
## 测试标签验证
|
||||
- [x] 选择文本翻译后输入文本能发送请求并显示翻译结果
|
||||
- [x] 选择语种识别后输入文本能发送请求并显示识别结果
|
||||
- [x] 响应信息正确显示状态码、响应时间、响应体大小
|
||||
- [x] 请求失败时显示错误信息
|
||||
|
||||
## 样式验证
|
||||
- [x] 详情页在桌面端显示正常
|
||||
- [x] 详情页在移动端响应式显示正常
|
||||
- [x] 标签切换动画流畅
|
||||
- [x] 接口列表卡片交互效果正确
|
||||
|
||||
## 代码质量验证
|
||||
- [x] 代码无 TypeScript 类型错误(新文件无错误)
|
||||
- [x] 代码通过 ESLint 检查
|
||||
- [x] 组件遵循现有代码风格和命名规范
|
||||
@@ -0,0 +1,81 @@
|
||||
# 百度翻译API详情页 Spec
|
||||
|
||||
## Why
|
||||
当前API接口大全中百度翻译已有路由映射(`/api/baiduFanyi` → `/baidu-translate`),但缺少一个专门的API详情页来展示文档和在线测试接口。需要创建一个详情页,让开发者了解百度翻译API的功能、参数和调用方式。
|
||||
|
||||
## What Changes
|
||||
- 新增 `BaiduTranslateDetail.tsx` 页面组件,展示百度翻译API文档和在线测试
|
||||
- 新增 `BaiduTranslateDetail.css` 样式文件
|
||||
- 在 `App.tsx` 中添加路由 `/api-detail/baidu-translate`
|
||||
- 在 `ApiDirectory.tsx` 的 `getApiRoute` 中添加路由映射
|
||||
- 百度翻译API支持四个子接口:文本翻译、语种识别、图片翻译、语音翻译
|
||||
|
||||
## Impact
|
||||
- Affected specs: api-directory-db
|
||||
- Affected code:
|
||||
- `chunyu_project_react/src/pages/BaiduTranslateDetail/BaiduTranslateDetail.tsx` - 新增详情页组件
|
||||
- `chunyu_project_react/src/pages/BaiduTranslateDetail/BaiduTranslateDetail.css` - 新增样式
|
||||
- `chunyu_project_react/src/App.tsx` - 新增路由
|
||||
- `chunyu_project_react/src/pages/ApiDirectory/ApiDirectory.tsx` - 更新路由映射
|
||||
|
||||
## ADDED Requirements
|
||||
|
||||
### Requirement: 百度翻译API详情页
|
||||
系统 SHALL 提供一个百度翻译API详情页,展示API文档和在线测试功能。
|
||||
|
||||
#### Scenario: 访问详情页
|
||||
- **WHEN** 用户访问 `/api-detail/baidu-translate`
|
||||
- **THEN** 显示百度翻译API详情页,包含文档标签和测试标签
|
||||
|
||||
#### Scenario: 从API接口大全跳转
|
||||
- **WHEN** 用户在API接口大全中点击百度翻译卡片
|
||||
- **THEN** 跳转到百度翻译API详情页
|
||||
|
||||
### Requirement: API文档展示
|
||||
系统 SHALL 在详情页展示百度翻译API的完整文档。
|
||||
|
||||
#### Scenario: 展示子接口列表
|
||||
- **WHEN** 用户切换到文档标签
|
||||
- **THEN** 显示四个子接口:文本翻译、语种识别、图片翻译、语音翻译
|
||||
|
||||
#### Scenario: 展示请求参数
|
||||
- **WHEN** 用户查看某个子接口
|
||||
- **THEN** 显示该接口的请求方法、URL、参数说明
|
||||
|
||||
#### Scenario: 展示响应示例
|
||||
- **WHEN** 用户查看某个子接口
|
||||
- **THEN** 显示该接口的JSON响应示例
|
||||
|
||||
### Requirement: 在线测试功能
|
||||
系统 SHALL 提供在线测试API接口的功能。
|
||||
|
||||
#### Scenario: 测试文本翻译
|
||||
- **WHEN** 用户在测试标签中选择文本翻译,输入文本后点击发送
|
||||
- **THEN** 调用后端API并显示翻译结果
|
||||
|
||||
#### Scenario: 测试语种识别
|
||||
- **WHEN** 用户在测试标签中选择语种识别,输入文本后点击发送
|
||||
- **THEN** 调用后端API并显示识别结果
|
||||
|
||||
#### Scenario: 显示响应信息
|
||||
- **WHEN** API请求完成
|
||||
- **THEN** 显示状态码、响应时间、响应体内容
|
||||
|
||||
### Requirement: 使用量统计展示
|
||||
系统 SHALL 在详情页展示当前用户的翻译使用统计。
|
||||
|
||||
#### Scenario: 展示使用统计
|
||||
- **WHEN** 用户访问详情页
|
||||
- **THEN** 显示今日翻译次数和累计翻译次数
|
||||
|
||||
## MODIFIED Requirements
|
||||
|
||||
### Requirement: API接口大全路由映射
|
||||
现有的 `getApiRoute` 函数 SHALL 更新百度翻译的路由映射。
|
||||
|
||||
#### Scenario: 点击百度翻译卡片
|
||||
- **WHEN** 用户在API接口大全点击百度翻译
|
||||
- **THEN** 跳转到 `/api-detail/baidu-translate` 而非 `/baidu-translate`
|
||||
|
||||
## REMOVED Requirements
|
||||
无
|
||||
@@ -0,0 +1,23 @@
|
||||
# Tasks
|
||||
|
||||
- [ ] Task 1: 创建百度翻译API详情页组件
|
||||
- [ ] SubTask 1.1: 创建 `BaiduTranslateDetail.tsx` 主组件文件
|
||||
- [ ] SubTask 1.2: 实现文档标签内容(子接口列表、参数说明、响应示例)
|
||||
- [ ] SubTask 1.3: 实现测试标签内容(接口选择、参数输入、发送请求、响应展示)
|
||||
- [ ] SubTask 1.4: 实现使用量统计展示
|
||||
|
||||
- [ ] Task 2: 创建详情页样式文件
|
||||
- [ ] SubTask 2.1: 创建 `BaiduTranslateDetail.css` 样式文件
|
||||
- [ ] SubTask 2.2: 实现文档标签样式
|
||||
- [ ] SubTask 2.3: 实现测试标签样式
|
||||
- [ ] SubTask 2.4: 实现响应式布局
|
||||
|
||||
- [ ] Task 3: 更新路由配置
|
||||
- [ ] SubTask 3.1: 在 `App.tsx` 中添加 `/api-detail/baidu-translate` 路由
|
||||
- [ ] SubTask 3.2: 在 `ApiDirectory.tsx` 中更新百度翻译的路由映射
|
||||
|
||||
- [ ] Task 4: 添加国际化翻译
|
||||
- [ ] SubTask 4.1: 在 i18n 配置中添加百度翻译详情页相关翻译键
|
||||
|
||||
# Task Dependencies
|
||||
- Task 3 依赖 Task 1(需要先创建组件才能添加路由)
|
||||
Reference in New Issue
Block a user