chore: 工作台产品化进行中的改动
把工作区里其余在制品一并入库,主要是工作台产品化的推进:
后端:新增 capability_definition / project / my_app_center / office_skill
接口与 action_definition / skill_definition / project / user_app_center
模型,config 加路由健康上报。
前端:新增 frontend/src/skills(Office 技能与 workbuddy 复刻)、
项目管理、应用中心、能力目录页,以及配套 api / store / config;
聊天侧新增 SpecialistChip / SpecialistPanel / SkillStrip / AppChatRail
等组件。
清理:移除旧 views/tools 下的单页工具(已并入工作台)、_frozen 冻结组件、
cmd/inspect_oa_debug 调试入口,以及两份调试笔记。
其它:文档与启动脚本同步。
(这批改动与上一提交的 SY23 工作并行进行,此前已在同一工作区内交织。)
Co-Authored-By: Claude Code <noreply@anthropic.com>
This commit is contained in:
+63
-14
@@ -1,18 +1,19 @@
|
||||
# eai_agentplatform_app — API 文档
|
||||
# eai_agentplatform — API 文档
|
||||
|
||||
> **版本:V1.1 | 协议:HTTP/JSON | 认证:JWT Bearer**
|
||||
> **最后更新:2026-08-15**
|
||||
>
|
||||
> **⚠️ 本文档为 V1.1 设计期基线,后端已重写为 Go + Gin(见 docs/changelog.md V1.2)。** V1.4–V1.7 新增的岗位(`/api/positions`)、部门(`/api/departments`)、消息(`/api/notifications`)、积分(`/api/points`)、证书(`/api/exam/certificates`)、错题本(`/api/exam/mistakes`)、学习档案(`/api/my/profile`)等接口未收录于本文档,以 `docs/changelog.md` 为准。
|
||||
> **版本:V1.3 | 协议:HTTP/JSON | 认证:JWT Bearer**
|
||||
> **后端:Go + Gin + GORM + SQLite**
|
||||
> **最后更新:2026-08-16**
|
||||
|
||||
---
|
||||
|
||||
## 通用约定
|
||||
|
||||
### 认证方式
|
||||
|
||||
所有 API(除 login 外)需在请求头携带:`Authorization: Bearer <token>`
|
||||
|
||||
### 响应格式
|
||||
|
||||
```json
|
||||
{
|
||||
"data": { ... },
|
||||
@@ -31,6 +32,7 @@
|
||||
```
|
||||
|
||||
### HTTP 状态码
|
||||
|
||||
| 状态码 | 含义 |
|
||||
|--------|------|
|
||||
| 200 | 成功 |
|
||||
@@ -47,6 +49,7 @@
|
||||
## 1. 认证 API
|
||||
|
||||
### `POST /api/auth/login`
|
||||
|
||||
**描述:** 登录获取 JWT Token
|
||||
|
||||
**请求体:**
|
||||
@@ -74,6 +77,7 @@
|
||||
```
|
||||
|
||||
### `GET /api/auth/me`
|
||||
|
||||
**描述:** 获取当前登录用户信息
|
||||
**认证:** 必需
|
||||
|
||||
@@ -82,6 +86,7 @@
|
||||
## 2. 公司介绍培训 API
|
||||
|
||||
### `GET /api/company-train`
|
||||
|
||||
**描述:** 获取公司介绍内容
|
||||
**认证:** 必需
|
||||
|
||||
@@ -103,6 +108,7 @@
|
||||
```
|
||||
|
||||
### `POST /api/company-train/suggest-material`
|
||||
|
||||
**描述:** 员工提交素材建议(弹窗)
|
||||
**认证:** 必需
|
||||
|
||||
@@ -115,25 +121,31 @@
|
||||
## 3. 产品知识 API
|
||||
|
||||
### `GET /api/products`
|
||||
|
||||
**描述:** 获取产品列表
|
||||
**参数:** `?category=capital_consulting`(可选,按分类筛选)
|
||||
**认证:** 必需
|
||||
|
||||
### `GET /api/products/{id}`
|
||||
|
||||
**描述:** 获取产品详情
|
||||
**认证:** 必需
|
||||
|
||||
### `POST /api/products` (管理员)
|
||||
|
||||
**描述:** 新增产品
|
||||
**认证:** 需 admin 角色
|
||||
|
||||
### `PUT /api/products/{id}` (管理员)
|
||||
|
||||
**描述:** 编辑产品
|
||||
|
||||
### `DELETE /api/products/{id}` (管理员)
|
||||
|
||||
**描述:** 停用产品(软删除)
|
||||
|
||||
### `POST /api/products/import` (管理员)
|
||||
|
||||
**描述:** 批量导入产品(Excel / JSON)
|
||||
|
||||
---
|
||||
@@ -141,19 +153,23 @@
|
||||
## 4. 销售培训 API
|
||||
|
||||
### `GET /api/courses`
|
||||
|
||||
**描述:** 获取课程列表
|
||||
**参数:** `?category=capital_script`(可选)
|
||||
**认证:** 必需
|
||||
|
||||
### `GET /api/courses/{id}`
|
||||
|
||||
**描述:** 获取课程详情(含绑定产品信息)
|
||||
**认证:** 必需
|
||||
|
||||
### `POST /api/courses` (管理员)
|
||||
|
||||
**描述:** 新增课程
|
||||
**认证:** 需 admin 角色
|
||||
|
||||
### `PUT /api/courses/{id}` (管理员)
|
||||
|
||||
**描述:** 编辑课程,绑定/解绑产品
|
||||
|
||||
---
|
||||
@@ -163,11 +179,13 @@
|
||||
### 5.1 题库管理(管理员)
|
||||
|
||||
#### `GET /api/exam/questions`
|
||||
|
||||
**描述:** 题目列表
|
||||
**参数:** `?domain=company&status=active`
|
||||
**认证:** 需 admin 角色
|
||||
|
||||
#### `POST /api/exam/questions`
|
||||
|
||||
**描述:** 新增题目
|
||||
**认证:** 需 admin 角色
|
||||
|
||||
@@ -182,7 +200,7 @@
|
||||
{"key": "A", "text": "资本咨询"},
|
||||
{"key": "B", "text": "AI产业落地"},
|
||||
{"key": "C", "text": "房地产开发"},
|
||||
{"key": "D", "text": "以上都是"}
|
||||
{"key": "D", "text":"以上都是"}
|
||||
],
|
||||
"answer": ["D"],
|
||||
"explanation": "博昇双主营业务为资本咨询与AI产业落地"
|
||||
@@ -190,17 +208,21 @@
|
||||
```
|
||||
|
||||
#### `PUT /api/exam/questions/{id}`
|
||||
|
||||
**描述:** 编辑题目
|
||||
|
||||
#### `DELETE /api/exam/questions/{id}`
|
||||
|
||||
**描述:** 停用题目
|
||||
|
||||
### 5.2 考试配置(管理员)
|
||||
|
||||
#### `GET /api/exam/papers`
|
||||
|
||||
**描述:** 考试配置列表
|
||||
|
||||
#### `POST /api/exam/papers`
|
||||
|
||||
**描述:** 创建考试配置
|
||||
**认证:** 需 admin 角色
|
||||
|
||||
@@ -221,14 +243,17 @@
|
||||
### 5.3 学员端考试
|
||||
|
||||
#### `GET /api/exam/list`
|
||||
|
||||
**描述:** 我的考试列表(所有可用考试 + 状态)
|
||||
**认证:** 必需
|
||||
|
||||
#### `GET /api/exam/cover?id={paperId}`
|
||||
|
||||
**描述:** 考试封面/说明
|
||||
**认证:** 必需
|
||||
|
||||
#### `POST /api/exam/start`
|
||||
|
||||
**描述:** 开始考试,下发题目
|
||||
**认证:** 必需
|
||||
|
||||
@@ -263,6 +288,7 @@
|
||||
```
|
||||
|
||||
#### `POST /api/exam/submit`
|
||||
|
||||
**描述:** 交卷判分
|
||||
**认证:** 必需
|
||||
|
||||
@@ -294,14 +320,14 @@
|
||||
}
|
||||
```
|
||||
|
||||
**响应(自测):** 同上,但不会持久化到 exam_record
|
||||
|
||||
#### `GET /api/exam/record`
|
||||
|
||||
**描述:** 我的考试记录列表
|
||||
**认证:** 必需(员工仅自己,管理员可看全部)
|
||||
**参数:** `?page=1&size=20`
|
||||
|
||||
#### `GET /api/exam/record/{recordId}`
|
||||
|
||||
**描述:** 考试记录详情(答题明细回溯)
|
||||
**认证:** 必需
|
||||
|
||||
@@ -310,6 +336,7 @@
|
||||
## 6. 素材/媒体 API
|
||||
|
||||
### `POST /api/media/upload`
|
||||
|
||||
**描述:** 上传文件(文档 ≤ 200MB 直传)
|
||||
**认证:** 必需
|
||||
|
||||
@@ -318,7 +345,8 @@
|
||||
- `bind_type`: company / product / course / none
|
||||
- `bind_id`: 绑定实体 ID(可选)
|
||||
|
||||
### `POST /api/media/upload-init`
|
||||
### `POST /api/media/upload/init`
|
||||
|
||||
**描述:** 初始化分片上传(视频 > 100MB)
|
||||
**认证:** 必需
|
||||
|
||||
@@ -343,7 +371,8 @@
|
||||
}
|
||||
```
|
||||
|
||||
### `POST /api/media/upload-chunk`
|
||||
### `POST /api/media/upload/chunk`
|
||||
|
||||
**描述:** 上传分片
|
||||
**认证:** 必需
|
||||
|
||||
@@ -352,7 +381,8 @@
|
||||
- `chunk_index`: 分片序号(从 0 开始)
|
||||
- `file`: 分片二进制
|
||||
|
||||
### `POST /api/media/upload-complete`
|
||||
### `POST /api/media/upload/complete`
|
||||
|
||||
**描述:** 完成分片上传,合并文件
|
||||
**认证:** 必需
|
||||
|
||||
@@ -364,10 +394,12 @@
|
||||
```
|
||||
|
||||
### `GET /api/media/preview/{mediaId}`
|
||||
|
||||
**描述:** 获取预览 URL / 信息(仅 approved 素材)
|
||||
**认证:** 必需
|
||||
|
||||
### `GET /api/media/status/{mediaId}`
|
||||
|
||||
**描述:** 查询素材状态(含提取进度)
|
||||
**认证:** 必需
|
||||
|
||||
@@ -376,11 +408,13 @@
|
||||
## 7. 素材审批 API(管理员)
|
||||
|
||||
### `GET /api/media/audit-list`
|
||||
|
||||
**描述:** 待审批素材列表
|
||||
**参数:** `?status=pending&page=1&size=20`
|
||||
**认证:** 需 admin 角色
|
||||
|
||||
### `POST /api/media/audit/{mediaId}`
|
||||
|
||||
**描述:** 审批素材
|
||||
**认证:** 需 admin 角色
|
||||
|
||||
@@ -399,6 +433,7 @@
|
||||
> 结构化知识源(`docs/knowledge_source/*.md`)的扫描、审批、摄入。完整设计见 `04_Backend/BE05_Knowledge_Ingest_Module.md`。
|
||||
|
||||
### `POST /api/knowledge/scan`
|
||||
|
||||
**描述:** 扫描 knowledge_source 目录,为新增/变更的 md 建 pending 记录
|
||||
**认证:** 需 admin 角色
|
||||
|
||||
@@ -414,11 +449,13 @@
|
||||
```
|
||||
|
||||
### `GET /api/knowledge/audit-list`
|
||||
|
||||
**描述:** 知识源审批列表
|
||||
**参数:** `?status=pending&page=1&size=20`
|
||||
**认证:** 需 admin 角色
|
||||
|
||||
### `POST /api/knowledge/audit/{sourceId}`
|
||||
|
||||
**描述:** 审批知识源(approve → 同步摄入 product/question/chunk;reject → 必填理由)
|
||||
**认证:** 需 admin 角色
|
||||
|
||||
@@ -444,6 +481,7 @@
|
||||
```
|
||||
|
||||
### `GET /api/knowledge/status/{sourceId}`
|
||||
|
||||
**描述:** 查询知识源审批/摄入状态
|
||||
**认证:** 必需
|
||||
|
||||
@@ -452,6 +490,7 @@
|
||||
## 9. AI PathCoach API
|
||||
|
||||
### `POST /api/ai-chat/message`
|
||||
|
||||
**描述:** 发送消息给 AI PathCoach
|
||||
**认证:** 必需
|
||||
|
||||
@@ -473,6 +512,7 @@ data: {"type": "done"}
|
||||
```
|
||||
|
||||
### `GET /api/ai-chat/quick-actions`
|
||||
|
||||
**描述:** 获取快捷按钮列表
|
||||
**认证:** 必需
|
||||
|
||||
@@ -490,6 +530,7 @@ data: {"type": "done"}
|
||||
```
|
||||
|
||||
### `POST /api/ai-chat/quick-action`
|
||||
|
||||
**描述:** 触发快捷动作
|
||||
**认证:** 必需
|
||||
|
||||
@@ -508,10 +549,12 @@ data: {"type": "done"}
|
||||
### 10.1 用户管理
|
||||
|
||||
#### `GET /api/system/users`
|
||||
|
||||
**描述:** 用户列表
|
||||
**认证:** 需 admin 角色
|
||||
|
||||
#### `POST /api/system/users`
|
||||
|
||||
**描述:** 创建用户
|
||||
**认证:** 需 admin 角色
|
||||
|
||||
@@ -526,24 +569,29 @@ data: {"type": "done"}
|
||||
```
|
||||
|
||||
#### `PUT /api/system/users/{id}`
|
||||
|
||||
**描述:** 编辑用户(可禁用、改角色)
|
||||
|
||||
### 10.2 考试成绩管理
|
||||
|
||||
#### `GET /api/system/exam-records`
|
||||
|
||||
**描述:** 全部考试成绩(支持按用户/考试筛选)
|
||||
**认证:** 需 admin 角色
|
||||
|
||||
#### `GET /api/system/exam-records/{id}`
|
||||
|
||||
**描述:** 考试记录详情
|
||||
|
||||
### 10.3 系统参数配置
|
||||
|
||||
#### `GET /api/system/config`
|
||||
|
||||
**描述:** 获取所有系统参数
|
||||
**认证:** 需 admin 角色
|
||||
|
||||
#### `PUT /api/system/config`
|
||||
|
||||
**描述:** 更新系统参数
|
||||
**认证:** 需 admin 角色
|
||||
|
||||
@@ -564,13 +612,14 @@ data: {"type": "done"}
|
||||
## 11. 健康检查
|
||||
|
||||
### `GET /api/health`
|
||||
|
||||
**描述:** 服务健康检查
|
||||
**认证:** 不需要
|
||||
**响应:**
|
||||
```json
|
||||
{
|
||||
"status": "ok",
|
||||
"service": "eai_agentplatform-app",
|
||||
"version": "1.1.0"
|
||||
"service": "eai_agentplatform",
|
||||
"version": "1.3.0"
|
||||
}
|
||||
```
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user