生成时间: 2026-05-11 基于 Go 参考项目规格适配 TypeScript/Express 实现
| 文档 | 路径 | 状态 | 说明 |
|---|---|---|---|
| 目录结构 | specs/STRUCTURE.md |
✅ 完成 | TypeScript 项目目录树、模块职责映射、关键配置文件 |
| 项目宪法 | specs/constitution.md |
✅ 完成 | 7 项治理原则（含类型安全）、修正程序 |
| 技术选型 | specs/TECH.md |
✅ 完成 | TypeScript、Express、Zod、Winston 等技术清单 |
| API 清单 | specs/API.md |
✅ 完成 | HTTP 端点、认证机制、CORS、命令行参数 |
| 架构总览 | specs/ARCHITECTURE.md |
✅ 完成 | Express 中间件链架构、数据流、模块交互 |
| 整体规格 | specs/overall-spec.md |
✅ 完成 | 13 项功能需求 + 5 项非功能需求 |
| 整体技术方案 | specs/overall-plan.md |
✅ 完成 | 技术方案、依赖关系、风险分析、改进方向 |
| 数据模型 | specs/overall-data-model.md |
✅ 完成 | Config、BackendConfig Zod Schema 与 TypeScript 类型 |
| 对外接口 | specs/overall-api.md |
✅ 完成 | API 合约、请求/响应规范、Zod 验证规则 |
| 测试用例 | specs/overall-test-cases.md |
✅ 完成 | 7 大类 25+ 测试用例 |
| 检查清单 | specs/SPECS_CHECKLIST.md |
✅ 完成 | 本文档 |
| 文档索引 | specs/README.md |
⏳ 待完成 | 项目介绍与文档导航 |
| 模块 | 路径 | spec.md | plan.md | 状态 |
|---|---|---|---|---|
| 001 配置模块 | specs/001-config-module/ |
⏳ | ⏳ | 待完成 |
| 002 代理模块 | specs/002-proxy-module/ |
⏳ | ⏳ | 待完成 |
| 003 请求处理模块 | specs/003-handler-module/ |
⏳ | ⏳ | 待完成 |
| 004 数据模型模块 | specs/004-model-module/ |
⏳ | ⏳ | 待完成 |
| 005 日志模块 | specs/005-logging-module/ |
⏳ | ⏳ | 待完成 |
| 006 工具模块 | specs/006-utils-module/ |
⏳ | ⏳ | 待完成 |
| 原则 | 验证项 | 状态 |
|---|---|---|
| P1: 源码即真相 | 所有规格文档的声明可追溯到源代码 | ✅ |
| P2: 模块化架构 | 每个模块文档对应一个 TypeScript 模块 | ✅ |
| P3: 配置驱动 | 配置行为在 spec 中完整文档化 | ✅ |
| P4: 透明可观测性 | 日志/脱敏行为在 spec 中文档化 | ✅ |
| P5: 安全优先 | API 密钥生成、脱敏在 spec 中文档化 | ✅ |
| P6: OpenAI 兼容 | API 兼容性在 spec 中文档化 | ✅ |
| P7: 类型安全 | Zod Schema 验证在 spec 中文档化 | ✅ |
| 来源文档 | 目标文档 | 引用关系 |
|---|---|---|
overall-spec.md (FR-01~FR-13) |
ARCHITECTURE.md |
功能需求 → 架构图 |
overall-spec.md (FR-10) |
001-config-module/spec.md |
配置管理需求 → 配置模块规格 |
overall-spec.md (FR-01, FR-06) |
002-proxy-module/spec.md |
路由/认证代理需求 → 代理模块规格 |
overall-spec.md (FR-02~FR-05, FR-08, FR-09) |
003-handler-module/spec.md |
别名/角色/参数/CORS/流式需求 → 处理模块规格 |
overall-spec.md (NFR-01~NFR-05) |
005-logging-module/spec.md |
非功能需求 → 日志模块规格 |
overall-data-model.md |
004-model-module/spec.md |
数据模型 → 模型模块规格 |
overall-api.md |
API.md |
API 合约 → API 清单 |
constitution.md |
所有模块 spec.md | 宪法原则 → 模块规格约束 |
| Go 模块 | TypeScript 模块 | 文档覆盖 |
|---|---|---|
cmd/main.go |
src/app.ts |
ARCHITECTURE.md, overall-plan.md |
config/config.go |
src/config/ |
001-config-module |
handler/handler.go |
src/middleware/ + src/handler/ |
003-handler-module |
proxy/proxy.go |
src/proxy/ |
002-proxy-module |
model/model.go |
src/types/ |
004-model-module |
logging/logging.go |
src/logger/ |
005-logging-module |
utils/utils.go |
src/utils/ |
006-utils-module |