实现服务启动时自动生成OpenAPI文档

主要变更:
1. 新增 cmd/api/docs.go 实现文档自动生成逻辑
2. 修改 cmd/api/main.go 在服务启动时调用文档生成
3. 重构 cmd/gendocs/main.go 提取生成函数
4. 更新 .gitignore 忽略自动生成的 openapi.yaml
5. 新增 Makefile 支持 make docs 命令
6. OpenSpec 框架更新和变更归档

功能特性:
- 服务启动时自动生成 OpenAPI 文档到项目根目录
- 保留独立的文档生成工具 (make docs)
- 生成失败时记录错误但不影响服务启动
- 所有代码已通过 openspec validate --strict 验证

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
This commit is contained in:
2026-01-09 12:25:50 +08:00
parent ddbc69135d
commit 6fc90abeb6
47 changed files with 1095 additions and 5519 deletions

View File

@@ -0,0 +1,56 @@
# dependency-injection Specification
## Purpose
TBD - created by archiving change refactor-framework-cleanup. Update Purpose after archive.
## Requirements
### Requirement: Bootstrap Package
系统 SHALL 提供 bootstrap 包,统一管理所有业务组件的初始化和依赖注入。
#### Scenario: 初始化所有组件
- **WHEN** 调用 Bootstrap(deps)
- **THEN** 自动初始化所有 Store、Service 和 Handler
- **AND** 返回可直接用于路由注册的 Handlers 结构体
#### Scenario: 依赖注入
- **WHEN** 初始化 Service 时
- **THEN** 自动注入所需的 Store 依赖
- **AND** 自动注入所需的其他 Service 依赖
#### Scenario: 添加新业务模块
- **WHEN** 需要添加新的业务模块
- **THEN** 只需修改 bootstrap 包
- **AND** main.go 无需任何修改
- **AND** TODO 注释标记扩展点
### Requirement: Main Function Simplification
main 函数 SHALL 只负责编排,不包含具体业务组件初始化逻辑。
#### Scenario: 标准启动流程
- **WHEN** 应用启动
- **THEN** main 函数执行以下步骤:
1. 加载配置
2. 初始化基础依赖DB、Redis、Logger
3. 调用 bootstrap.Bootstrap() 初始化业务组件
4. 设置路由和中间件
5. 启动服务器
#### Scenario: 启动失败处理
- **WHEN** 任何初始化步骤失败
- **THEN** 记录错误日志
- **AND** 程序以非零状态码退出
### Requirement: Dependencies Encapsulation
系统 SHALL 使用结构体封装基础依赖和业务组件。
#### Scenario: Dependencies 结构体
- **WHEN** 传递基础依赖时
- **THEN** 使用 Dependencies 结构体封装 DB、Redis、Logger
#### Scenario: Handlers 结构体
- **WHEN** 返回业务处理器时
- **THEN** 使用 Handlers 结构体封装所有 Handler
- **AND** 结构体包含 TODO 注释标记未来扩展点