!14 docs: 添加任务完成后自动更新文档并提交的规范
Merge pull request !14 from 何朝晖/docs/update
This commit is contained in:
@@ -71,3 +71,4 @@ npm run typecheck
|
|||||||
- API 路径统一使用 `/api/v1/` 前缀。
|
- API 路径统一使用 `/api/v1/` 前缀。
|
||||||
- 错误响应统一格式:`{"code": int, "message": string, "data": any}`。
|
- 错误响应统一格式:`{"code": int, "message": string, "data": any}`。
|
||||||
- Git commit message 使用中文或英文均可,但需要清晰描述变更内容。
|
- Git commit message 使用中文或英文均可,但需要清晰描述变更内容。
|
||||||
|
- 每次小任务执行完毕后,检查并更新 `docs/` 下相关文档(如 API 状态、后端文件结构等),然后自动提交 commit,但不要 push。commit message 禁止使用 Co-Authored-By 签名。
|
||||||
|
|||||||
+2
-2
@@ -59,8 +59,8 @@ Token 过期或无效时返回:
|
|||||||
|
|
||||||
| 状态 | 方法 | 路径 | 说明 |
|
| 状态 | 方法 | 路径 | 说明 |
|
||||||
|------|------|------|------|
|
|------|------|------|------|
|
||||||
| [ ] | POST | `/api/v1/auth/register` | 用户注册 |
|
| [x] | POST | `/api/v1/auth/register` | 用户注册 |
|
||||||
| [ ] | POST | `/api/v1/auth/login` | 用户登录 |
|
| [x] | POST | `/api/v1/auth/login` | 用户登录 |
|
||||||
| [ ] | GET | `/api/v1/auth/me` | 获取当前用户信息 |
|
| [ ] | GET | `/api/v1/auth/me` | 获取当前用户信息 |
|
||||||
| [ ] | PUT | `/api/v1/auth/password` | 修改密码 |
|
| [ ] | PUT | `/api/v1/auth/password` | 修改密码 |
|
||||||
|
|
||||||
|
|||||||
+10
-8
@@ -11,21 +11,23 @@
|
|||||||
```
|
```
|
||||||
backend/internal/
|
backend/internal/
|
||||||
├── handler/ # HTTP handlers(薄层,只做参数绑定 + 调用 service)
|
├── handler/ # HTTP handlers(薄层,只做参数绑定 + 调用 service)
|
||||||
│ ├── auth.go # 用户注册 / 登录 / 当前用户 / 修改密码
|
│ ├── health.go # [已有] 健康检查
|
||||||
|
│ ├── register.go # [已有] 用户注册(handler 骨架 + 参数校验)
|
||||||
|
│ ├── login.go # [已有] 用户登录(handler 骨架 + 参数校验)
|
||||||
│ ├── project.go # 工程 CRUD + 任务列表
|
│ ├── project.go # 工程 CRUD + 任务列表
|
||||||
│ ├── generate.go # 生成任务提交 / 查询 / WebSocket
|
│ ├── generate.go # 生成任务提交 / 查询 / WebSocket
|
||||||
│ ├── project_style.go # 工程风格 CRUD
|
│ └── project_style.go # 工程风格 CRUD
|
||||||
│ └── health.go # [已有] 健康检查
|
|
||||||
├── service/ # 业务逻辑层
|
├── service/ # 业务逻辑层
|
||||||
|
│ ├── pipeline.go # [已有] Eino compose.Graph 编排:PromptBuilder → AssetGenerator → QualitySupervisor → FormatAdapter
|
||||||
|
│ ├── nodes.go # [已有] 管线四个节点的实现(每个节点单一职责)
|
||||||
|
│ ├── types.go # [已有] 管线输入/状态/输出的显式结构体定义
|
||||||
|
│ ├── inference.go # [已有] AI 推理 API 调用封装(当前为 mock 实现)
|
||||||
|
│ ├── pipeline_test.go # [已有] 管线测试(happy path / 重试 / 降级 / 风格合并)
|
||||||
│ ├── auth.go # 用户认证:注册、登录、JWT 签发与校验
|
│ ├── auth.go # 用户认证:注册、登录、JWT 签发与校验
|
||||||
│ ├── pipeline.go # Eino compose.Graph 编排:PromptBuilder → AssetGenerator → QualitySupervisor → FormatAdapter
|
|
||||||
│ ├── nodes.go # 管线四个节点的实现(每个节点单一职责)
|
|
||||||
│ ├── types.go # 管线输入/状态/输出的显式结构体定义
|
|
||||||
│ ├── inference.go # AI 推理 API 调用封装(Eino model 组件)
|
|
||||||
│ └── project_style.go # 工程风格管理 & 风格合并逻辑
|
│ └── project_style.go # 工程风格管理 & 风格合并逻辑
|
||||||
├── model/ # 数据模型 / DTO
|
├── model/ # 数据模型 / DTO
|
||||||
│ ├── response.go # [已有] 统一响应
|
│ ├── response.go # [已有] 统一响应
|
||||||
│ ├── user.go # 用户模型
|
│ ├── user.go # [已有] 用户模型
|
||||||
│ ├── task.go # 生成任务 & 素材
|
│ ├── task.go # 生成任务 & 素材
|
||||||
│ └── style.go # 工程风格 & 任务风格覆盖
|
│ └── style.go # 工程风格 & 任务风格覆盖
|
||||||
├── middleware/ # 中间件
|
├── middleware/ # 中间件
|
||||||
|
|||||||
Reference in New Issue
Block a user