58 lines
2.5 KiB
Markdown
58 lines
2.5 KiB
Markdown
# 二维码生成API详情页 Spec
|
|
|
|
## Why
|
|
需要为二维码生成工具创建一个API详情页，参考现有的天气查询API详情页模式，使前后端保持一致，方便开发者理解和使用二维码生成接口。
|
|
|
|
## What Changes
|
|
- **新增API详情页**：为二维码生成工具创建独立的API详情页面
|
|
- **参数文档化**：将所有二维码生成参数整理成表格形式，包含参数名、类型、必填、描述
|
|
- **响应示例**：提供二维码生成的响应示例数据
|
|
- **接口测试**：提供在线测试界面，支持输入参数并查看响应
|
|
|
|
## Impact
|
|
- Affected specs: 无
|
|
- Affected code:
|
|
- `src/pages/QRCodeGenerator/QRCodeGeneratorApiDetail.tsx` - 新增API详情页组件
|
|
- `src/pages/QRCodeGenerator/QRCodeGeneratorApiDetail.css` - 新增样式文件
|
|
- `src/App.tsx` - 添加路由配置
|
|
|
|
## ADDED Requirements
|
|
### Requirement: 二维码生成API详情页
|
|
系统应提供二维码生成API的文档页面，包含接口说明、参数文档、响应示例和在线测试功能。
|
|
|
|
#### Scenario: API详情页展示
|
|
- **WHEN** 用户访问 `/api/qrcode-generator`
|
|
- **THEN** 页面显示API文档标签页和接口测试标签页
|
|
- **AND** 文档标签页包含接口名称、请求地址、请求方法
|
|
- **AND** 参数表格列出所有支持的参数及其说明
|
|
|
|
#### Scenario: 参数文档完整性
|
|
- **WHEN** 用户查看API参数文档
|
|
- **THEN** 参数表格包含以下字段：参数名、类型、必填、描述
|
|
- **AND** 参数包括：text、errorLevel、version、margin、size、fgColor、bgColor、dotStyle、finderStyle、logo
|
|
- **AND** 每个参数都有清晰的默认值说明
|
|
|
|
#### Scenario: 响应示例
|
|
- **WHEN** 用户查看响应示例
|
|
- **THEN** 页面显示标准的JSON响应格式
|
|
- **AND** 包含成功响应（200）的示例数据
|
|
- **AND** 包含错误码说明表格
|
|
|
|
### Requirement: 在线测试功能
|
|
API详情页应提供在线测试界面，支持用户输入参数并查看响应结果。
|
|
|
|
#### Scenario: API测试
|
|
- **WHEN** 用户在测试标签页输入参数并点击发送
|
|
- **THEN** 系统显示请求状态（成功/失败）
|
|
- **AND** 显示响应时间
|
|
- **AND** 显示响应体内容
|
|
|
|
## MODIFIED Requirements
|
|
### Requirement: 路由配置
|
|
需要在现有路由配置中添加二维码生成API详情页的路由。
|
|
|
|
#### Scenario: 路由访问
|
|
- **WHEN** 用户访问 `/api/qrcode-generator`
|
|
- **THEN** 系统正确渲染二维码生成API详情页
|
|
- **AND** 页面样式与其他API详情页保持一致
|