docs: 更新 CHANGELOG 记录 API 生成器修复
- 添加 OpenAPI 生成器 title 字段识别修复的记录 - 详细说明影响文件和技术细节 Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Showing
1 changed file
with
22 additions
and
0 deletions
| ... | @@ -5,6 +5,28 @@ | ... | @@ -5,6 +5,28 @@ |
| 5 | 5 | ||
| 6 | --- | 6 | --- |
| 7 | 7 | ||
| 8 | +## [2026-02-10] - 修复 OpenAPI 生成器识别 title 字段 | ||
| 9 | + | ||
| 10 | +### 修复 | ||
| 11 | +- **修复 API 生成器**:`generateApiFromOpenAPI.js` 现在同时支持 `description` 和 `title` 字段 | ||
| 12 | + - 优先使用 `description`,如果为空则使用 `title` | ||
| 13 | + - 解决了 OpenAPI 文档中使用 `title` 字段时无法提取中文描述的问题 | ||
| 14 | +- **更新 OpenAPI 文档**: | ||
| 15 | + - 将 `plan/add.md` 从 `application/x-www-form-urlencoded` 改为 `application/json` | ||
| 16 | + - 使用 `title` 字段存储参数中文描述 | ||
| 17 | + - 修正参数类型(如 `customer_age` 从 `string` 改为 `integer`) | ||
| 18 | +- **重新生成 API 文件**: | ||
| 19 | + - `src/api/plan.js` - 参数描述现在正确显示中文名称 | ||
| 20 | + - `src/api/user.js` - 参数描述优化 | ||
| 21 | + | ||
| 22 | +**详细信息**: | ||
| 23 | +- **影响文件**: scripts/generateApiFromOpenAPI.js, src/api/plan.js, src/api/user.js, docs/api-specs/plan/add.md | ||
| 24 | +- **技术栈**: Node.js, OpenAPI Specification | ||
| 25 | +- **测试状态**: 已验证 | ||
| 26 | +- **备注**: 提升了 API 文档生成的准确性 | ||
| 27 | + | ||
| 28 | +--- | ||
| 29 | + | ||
| 8 | ## [2026-02-10] - 优化 NameInput 组件样式 | 30 | ## [2026-02-10] - 优化 NameInput 组件样式 |
| 9 | 31 | ||
| 10 | ### 优化 | 32 | ### 优化 | ... | ... |
-
Please register or login to post a comment