docs: 新增 API 接口文档

jk-rag-platform/docs/API.md

@@ -0,0 +1,465 @@
+# API 接口文档
+
+**项目**: 建科小智开放平台
+**版本**: v3.8
+**最后更新**: 2026-04-02
+
+---
+
+## 目录
+
+1. [认证 API](#认证-api)
+2. [应用管理 API](#应用管理-api)
+3. [知识库管理 API](#知识库管理-api)
+4. [文档管理 API](#文档管理-api)
+5. [切片管理 API](#切片管理-api)
+6. [审核管理 API](#审核管理-api)
+7. [首页统计 API](#首页统计-api)
+8. [修订工具 API](#修订工具-api)
+
+---
+
+## 认证 API
+
+### 1. 用户登录
+```
+POST /auth/login
+```
+
+**请求参数**:
+| 参数 | 类型 | 必填 | 说明 |
+|------|------|------|------|
+| username | string | 是 | 用户名 |
+| password | string | 是 | 密码 |
+| code | string | 否 | 验证码 |
+
+**响应示例**:
+```json
+{
+    "code": 200,
+    "message": "登录成功",
+    "data": {
+        "token": "mock_token_xxx",
+        "refreshToken": "mock_refresh_token_xxx",
+        "expiresAt": 1234567890000,
+        "user": {
+            "id": "current_user",
+            "username": "zhangsan",
+            "realName": "张三",
+            "email": "zhangsan@jianke.com",
+            "department": "技术研发部",
+            "position": "高级开发工程师"
+        }
+    }
+}
+```
+
+### 2. 获取验证码
+```
+GET /auth/code?phone=xxx&email=xxx
+```
+
+**响应示例**:
+```json
+{
+    "code": 200,
+    "message": "验证码已发送",
+    "data": {
+        "debugCode": "1234",
+        "expiresInSeconds": 300
+    }
+}
+```
+
+### 3. 获取用户信息
+```
+GET /system/user/getInfo
+```
+**请求头**: `Authorization: Bearer {token}`
+
+---
+
+## 应用管理 API
+
+### 1. 获取应用列表
+```
+POST /bigmodel/api/getApplicationList
+```
+
+**请求参数**:
+| 参数 | 类型 | 必填 | 说明 |
+|------|------|------|------|
+| pageNum | number | 否 | 页码，默认 1 |
+| pageSize | number | 否 | 每页条数，默认 10 |
+| category | string | 否 | 分类：professional/functional/project |
+| status | string | 否 | 状态：online/offline/auditing/rejected |
+| keyword | string | 否 | 搜索关键词 |
+
+**响应示例**:
+```json
+{
+    "code": 200,
+    "message": "success",
+    "data": {
+        "list": [
+            {
+                "id": "app_001",
+                "name": "合同审查助手",
+                "description": "基于 RAG 技术的智能合同审查与风险提示工具",
+                "category": "professional",
+                "status": "online",
+                "creatorId": "user_001",
+                "creator": "张三",
+                "maintainers": ["张三", "李四"],
+                "createdAt": "2025-12-15 10:30:00",
+                "updatedAt": "2026-01-05 14:20:00",
+                "knowledgeBaseCount": 3,
+                "conversationCount": 1250
+            }
+        ],
+        "total": 18,
+        "pageNum": 1,
+        "pageSize": 10
+    }
+}
+```
+
+### 2. 获取应用详情
+```
+GET /bigmodel/api/selectApplication/:id
+```
+
+### 3. 创建应用
+```
+POST /bigmodel/api/createApplication
+```
+
+**请求参数**:
+| 参数 | 类型 | 必填 | 说明 |
+|------|------|------|------|
+| name | string | 是 | 应用名称 |
+| description | string | 是 | 应用描述 |
+| category | string | 是 | 应用分类 |
+| knowledgeBaseIds | array | 否 | 关联的知识库 ID 列表 |
+
+### 4. 更新应用
+```
+PUT /bigmodel/api/updateApplication/:id
+```
+
+### 5. 删除应用
+```
+DELETE /bigmodel/api/delApplication/:id
+```
+
+---
+
+## 知识库管理 API
+
+### 1. 获取知识库列表
+```
+POST /bigmodel/api/knowledgeList
+```
+
+### 2. 获取知识库详情
+```
+GET /bigmodel/api/detailKnowledge/:id
+```
+
+### 3. 创建知识库
+```
+POST /bigmodel/api/createKnowledge
+```
+
+### 4. 更新知识库
+```
+PUT /bigmodel/api/updateKnowledge/:id
+```
+
+### 5. 删除知识库
+```
+DELETE /bigmodel/api/delKnowledge/:id
+```
+
+### 6. 获取 Embedding 列表
+```
+GET /bigmodel/api/embedding
+```
+
+---
+
+## 文档管理 API
+
+### 1. 获取文档列表
+```
+POST /bigmodel/api/documentList
+```
+
+### 2. 获取文档详情
+```
+GET /bigmodel/api/documentDetail/:id
+```
+
+### 3. 更新文档
+```
+PUT /bigmodel/api/updateDocument/:id
+```
+
+### 4. 删除文档
+```
+DELETE /bigmodel/api/delDocument/:id
+```
+
+### 5. 上传文档
+```
+POST /bigmodel/api/uploadDocument/:knowledgeId
+```
+
+### 6. 获取文档设置
+```
+GET /bigmodel/api/documentSetting/:id
+```
+
+### 7. 更新文档设置
+```
+PUT /bigmodel/api/updateDocumentSetting/:id
+```
+
+---
+
+## 切片管理 API
+
+### 1. 获取切片列表
+```
+POST /bigmodel/api/getSliceList
+```
+
+### 2. 获取切片详情
+```
+GET /bigmodel/api/getSliceDetail/:sliceId/:knowledgeId
+```
+
+### 3. 添加切片
+```
+POST /bigmodel/api/add/slice
+```
+
+### 4. 更新切片
+```
+PUT /bigmodel/api/updateSliceInfo
+```
+
+### 5. 删除切片
+```
+DELETE /bigmodel/api/deleteSlice/:sliceId/:knowledgeId/:documentId
+```
+
+---
+
+## 审核管理 API
+
+### 1. 获取审核列表
+```
+POST /deepseek/api/app/audit/list
+```
+
+**请求参数**:
+| 参数 | 类型 | 必填 | 说明 |
+|------|------|------|------|
+| pageNum | number | 否 | 页码，默认 1 |
+| pageSize | number | 否 | 每页条数，默认 10 |
+| status | string | 否 | 状态：pending/approved/rejected |
+| keyword | string | 否 | 搜索关键词 |
+
+**响应示例**:
+```json
+{
+    "code": 200,
+    "message": "success",
+    "data": {
+        "list": [
+            {
+                "id": "audit_001",
+                "appId": "app_006",
+                "appName": "安全生产管理系统",
+                "appDescription": "安全生产规范、应急预案、事故案例分析",
+                "creatorId": "user_006",
+                "creator": "孙八",
+                "department": "安全管理部",
+                "submitTime": "2026-01-16 15:45:00",
+                "auditStatus": "pending",
+                "auditor": null,
+                "auditTime": null,
+                "auditOpinion": null,
+                "knowledgeBaseCount": 4,
+                "documentCount": 28,
+                "sliceCount": 156
+            }
+        ],
+        "total": 6,
+        "pageNum": 1,
+        "pageSize": 10
+    }
+}
+```
+
+### 2. 获取审核详情
+```
+GET /deepseek/api/app/audit/detail/:id
+```
+
+### 3. 审核操作
+```
+PUT /deepseek/api/app/audit/auditAction
+```
+
+**请求参数**:
+| 参数 | 类型 | 必填 | 说明 |
+|------|------|------|------|
+| auditId | string | 是 | 审核 ID |
+| action | string | 是 | 操作：approve/reject |
+| opinion | string | 是 | 审核意见 |
+
+### 4. 获取审核历史
+```
+POST /deepseek/api/app/auditHistory/list
+```
+
+### 5. 获取审核统计
+```
+GET /deepseek/api/app/audit/stats
+```
+
+**响应示例**:
+```json
+{
+    "code": 200,
+    "message": "success",
+    "data": {
+        "total": 6,
+        "pending": 3,
+        "approved": 2,
+        "rejected": 1,
+        "pendingRate": "50.0",
+        "approvedRate": "33.3",
+        "rejectedRate": "16.7"
+    }
+}
+```
+
+---
+
+## 首页统计 API
+
+### 1. 获取概览数据
+```
+GET /deepseek/overview/topData
+```
+
+**响应示例**:
+```json
+{
+    "code": 200,
+    "message": "success",
+    "data": {
+        "totalApps": 18,
+        "onlineApps": 14,
+        "auditingApps": 2,
+        "offlineApps": 2,
+        "totalKnowledgeBases": 45,
+        "totalDocuments": 328,
+        "totalSlices": 2156,
+        "totalConversations": 12580,
+        "todayConversations": 156,
+        "activeUsers": 89,
+        "pendingAudits": 3,
+        "conversationTrend": [...],
+        "categoryStats": [...],
+        "topApps": [...],
+        "recentActivities": [...]
+    }
+}
+```
+
+### 2. 获取在线用户数据
+```
+GET /deepseek/overview/onlineUserData
+```
+
+### 3. 获取会话数据
+```
+GET /deepseek/overview/conversationData
+```
+
+---
+
+## 修订工具 API
+
+### 1. 获取修订列表
+```
+GET /deepseek/revise/pageList
+```
+
+### 2. 获取修订全部列表
+```
+GET /deepseek/revise/list
+```
+
+### 3. 获取修订切片列表
+```
+GET /deepseek/revise/sliceList
+```
+
+### 4. 提交修订切片
+```
+PUT /deepseek/revise/reviseSlice
+```
+
+### 5. 获取修订历史
+```
+GET /deepseek/revise/reviseHistoryList
+```
+
+---
+
+## 字典数据 API
+
+### 1. 标准分类
+```
+GET /deepseek/api/standard_classification
+```
+
+### 2. 解析类型
+```
+GET /deepseek/api/parsing_type
+```
+
+### 3. 分割类型
+```
+GET /deepseek/api/splitting_type
+```
+
+### 4. 修订状态
+```
+GET /deepseek/api/revision_status
+```
+
+---
+
+## 聊天记录 API
+
+### 1. 获取聊天记录列表
+```
+POST /bigmodel/api/chatHistory/list
+```
+
+### 2. 导出聊天记录
+```
+POST /bigmodel/api/dialog/export/:id
+```
+
+---
+
+**备注**:
+- 所有 API 的 Mock 数据位于 `src/mock/` 目录下
+- 在 `src/apis/api.ts` 中通过 `USE_MOCK` 标志切换 Mock/真实 API