Boonlive_RD_Web/Web_BAI_Manage_ApiServer
9
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

feat: 添加文档管理和登录页面功能，包含文档上传、列表展示及用户登录逻辑；新增数据库表结构初始化脚本

Browse Source
This commit is contained in:
徐
2026-03-27 10:27:44 +08:00
parent 836e660842
commit 9feb0bb3a0
23 changed files with 2483 additions and 104 deletions
Download Patch File Download Diff File Expand all files Collapse all files

679
pocket-base/spec/openapi.yaml
View File

@@ -9,7 +9,7 @@ info:
请在 Apifox 环境中统一设置全局 Header：`Authorization: Bearer {{token}}`。
version: 1.0.0
servers:
- url: https://bai-api.blv-oa.com/pb
- url: https://bai-api.blv-oa.com
description: 生产环境
- url: http://localhost:8090
description: PocketBase 本地环境
@@ -22,6 +22,12 @@ tags:
description: 面向平台用户的认证接口；平台用户会生成 GUID 并写入统一 `openid` 字段。
- name: 字典管理
description: 面向 ManagePlatform 用户的系统字典维护接口。
- name: 附件管理
description: 面向 ManagePlatform 用户的附件上传、查询与删除接口。
- name: 文档管理
description: 面向 ManagePlatform 用户的文档新增、查询、修改、删除接口；查询时会自动返回关联附件的 PocketBase 文件流链接。
- name: 文档历史
description: 面向 ManagePlatform 用户的文档操作历史查询接口。
components:
schemas:
ApiResponse:
@@ -358,8 +364,286 @@ components:
dict_name:
type: string
example: 用户状态
AttachmentRecord:
type: object
properties:
pb_id:
type: string
attachments_id:
type: string
attachments_link:
type: string
description: PocketBase 实际存储的文件名
attachments_url:
type: string
description: 附件文件流访问链接
attachments_download_url:
type: string
description: 附件下载链接
attachments_filename:
type: string
attachments_filetype:
type: string
attachments_size:
type: number
attachments_owner:
type: string
attachments_md5:
type: string
attachments_ocr:
type: string
attachments_status:
type: string
attachments_remark:
type: string
created:
type: string
updated:
type: string
AttachmentListRequest:
type: object
properties:
keyword:
type: string
description: 对 `attachments_id`、`attachments_filename` 的模糊搜索关键字
example: 手册
status:
type: string
description: 按附件状态过滤
example: active
AttachmentDetailRequest:
type: object
required: [attachments_id]
properties:
attachments_id:
type: string
example: ATT-1743037200000-abc123
AttachmentUploadRequest:
type: object
required: [attachments_link]
properties:
attachments_link:
type: string
format: binary
description: 要上传到 `tbl_attachments` 的单个文件
attachments_filename:
type: string
description: 原始文件名；不传时可由前端直接使用文件名
attachments_filetype:
type: string
description: 文件 MIME 类型
attachments_size:
type: number
description: 文件大小
attachments_md5:
type: string
attachments_ocr:
type: string
attachments_status:
type: string
example: active
attachments_remark:
type: string
DocumentRecord:
type: object
properties:
pb_id:
type: string
document_id:
type: string
document_effect_date:
type: string
document_expiry_date:
type: string
document_type:
type: string
document_title:
type: string
document_subtitle:
type: string
document_summary:
type: string
document_content:
type: string
document_image:
type: string
description: 关联的 `attachments_id`
document_image_url:
type: string
description: 根据 `document_image -> tbl_attachments` 自动解析出的图片文件流链接
document_image_attachment:
allOf:
- $ref: '#/components/schemas/AttachmentRecord'
nullable: true
document_video:
type: string
description: 关联的 `attachments_id`
document_video_url:
type: string
description: 根据 `document_video -> tbl_attachments` 自动解析出的视频文件流链接
document_video_attachment:
allOf:
- $ref: '#/components/schemas/AttachmentRecord'
nullable: true
document_owner:
type: string
description: 上传者 openid
document_relation_model:
type: string
document_keywords:
type: string
description: 多值字段，使用 `|` 分隔
document_share_count:
type: number
document_download_count:
type: number
document_favorite_count:
type: number
document_status:
type: string
document_embedding_status:
type: string
document_embedding_error:
type: string
document_embedding_lasttime:
type: string
document_vector_version:
type: string
document_product_categories:
type: string
description: 多值字段，使用 `|` 分隔
document_application_scenarios:
type: string
description: 多值字段，使用 `|` 分隔
document_hotel_type:
type: string
description: 多值字段，使用 `|` 分隔
document_remark:
type: string
created:
type: string
updated:
type: string
DocumentListRequest:
type: object
properties:
keyword:
type: string
description: 对 `document_id`、`document_title`、`document_subtitle`、`document_summary`、`document_keywords` 的模糊搜索关键字
example: 安装
status:
type: string
example: active
document_type:
type: string
example: 说明书
DocumentDetailRequest:
type: object
required: [document_id]
properties:
document_id:
type: string
example: DOC-1743037200000-abc123
DocumentMutationRequest:
type: object
properties:
document_id:
type: string
description: 创建时可不传，由服务端自动生成；更新时必填
example: DOC-1743037200000-abc123
document_effect_date:
type: string
description: 支持 `YYYY-MM-DD` 或 PocketBase 可识别日期时间字符串
example: 2026-03-27
document_expiry_date:
type: string
description: 支持 `YYYY-MM-DD` 或 PocketBase 可识别日期时间字符串
example: 2027-03-27
document_type:
type: string
document_title:
type: string
document_subtitle:
type: string
document_summary:
type: string
document_content:
type: string
document_image:
type: string
description: 图片附件的 `attachments_id`
document_video:
type: string
description: 视频附件的 `attachments_id`
document_relation_model:
type: string
document_keywords:
type: string
description: 多值字段，使用 `|` 分隔
document_share_count:
type: number
document_download_count:
type: number
document_favorite_count:
type: number
document_status:
type: string
document_embedding_status:
type: string
document_embedding_error:
type: string
document_embedding_lasttime:
type: string
document_vector_version:
type: string
document_product_categories:
type: string
description: 多值字段，使用 `|` 分隔
document_application_scenarios:
type: string
description: 多值字段，使用 `|` 分隔
document_hotel_type:
type: string
description: 多值字段，使用 `|` 分隔
document_remark:
type: string
DocumentDeleteRequest:
type: object
required: [document_id]
properties:
document_id:
type: string
example: DOC-1743037200000-abc123
DocumentHistoryRecord:
type: object
properties:
pb_id:
type: string
doh_id:
type: string
doh_document_id:
type: string
doh_operation_type:
type: string
doh_user_id:
type: string
doh_current_count:
type: number
doh_remark:
type: string
created:
type: string
updated:
type: string
DocumentHistoryListRequest:
type: object
properties:
document_id:
type: string
description: 可选；传入时仅查询指定文档的操作历史
example: DOC-1743037200000-abc123
paths:
/api/system/test-helloworld:
/pb/api/system/test-helloworld:
post:
tags: [系统]
summary: HelloWorld 测试接口
@@ -375,7 +659,7 @@ paths:
properties:
data:
$ref: '#/components/schemas/HelloWorldData'
/api/system/health:
/pb/api/system/health:
post:
tags: [系统]
summary: 健康检查
@@ -391,7 +675,7 @@ paths:
properties:
data:
$ref: '#/components/schemas/HealthData'
/api/system/users-count:
/pb/api/system/users-count:
post:
tags: [系统]
summary: 查询用户总数
@@ -408,7 +692,7 @@ paths:
properties:
data:
$ref: '#/components/schemas/UsersCountData'
/api/system/refresh-token:
/pb/api/system/refresh-token:
post:
tags: [系统]
summary: 刷新系统认证 token
@@ -451,7 +735,7 @@ paths:
description: 请求体必须为 application/json
'429':
description: 重复请求过于频繁
/api/wechat/login:
/pb/api/wechat/login:
post:
tags: [微信认证]
summary: 微信登录/注册合一
@@ -483,7 +767,7 @@ paths:
description: 重复请求过于频繁
'500':
description: 保存 auth 用户失败或服务端内部错误
/api/platform/register:
/pb/api/platform/register:
post:
tags: [平台认证]
summary: 平台用户注册
@@ -513,7 +797,7 @@ paths:
description: 请求体必须为 application/json
'429':
description: 重复请求过于频繁
/api/platform/login:
/pb/api/platform/login:
post:
tags: [平台认证]
summary: 平台用户登录
@@ -575,7 +859,7 @@ paths:
description: 请求体必须为 application/json
'429':
description: 重复请求过于频繁
/api/wechat/profile:
/pb/api/wechat/profile:
post:
tags: [微信认证]
summary: 更新微信用户资料
@@ -604,7 +888,7 @@ paths:
description: token 无效或当前 auth record 缺少统一身份字段 openid
'400':
description: 参数错误、手机号已被注册或资料更新失败
/api/dictionary/list:
/pb/api/dictionary/list:
post:
tags: [字典管理]
summary: 查询字典列表
@@ -640,7 +924,7 @@ paths:
description: 非 ManagePlatform 用户无权访问
'415':
description: 请求体必须为 application/json
/api/dictionary/detail:
/pb/api/dictionary/detail:
post:
tags: [字典管理]
summary: 查询指定字典
@@ -675,7 +959,7 @@ paths:
description: 未找到对应字典
'415':
description: 请求体必须为 application/json
/api/dictionary/create:
/pb/api/dictionary/create:
post:
tags: [字典管理]
summary: 新增字典
@@ -711,7 +995,7 @@ paths:
description: 请求体必须为 application/json
'429':
description: 重复请求过于频繁
/api/dictionary/update:
/pb/api/dictionary/update:
post:
tags: [字典管理]
summary: 修改字典
@@ -748,7 +1032,7 @@ paths:
description: 请求体必须为 application/json
'429':
description: 重复请求过于频繁
/api/dictionary/delete:
/pb/api/dictionary/delete:
post:
tags: [字典管理]
summary: 删除字典
@@ -788,3 +1072,370 @@ paths:
description: 请求体必须为 application/json
'429':
description: 重复请求过于频繁
/pb/api/attachment/list:
post:
tags: [附件管理]
summary: 查询附件列表
description: |
仅允许 `ManagePlatform` 用户访问。
支持按 `attachments_id`、`attachments_filename` 模糊搜索，并可按 `attachments_status` 过滤。
requestBody:
required: false
content:
application/json:
schema:
$ref: '#/components/schemas/AttachmentListRequest'
responses:
'200':
description: 查询成功
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ApiResponse'
- type: object
properties:
data:
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/AttachmentRecord'
'401':
description: token 无效或已过期
'403':
description: 非 ManagePlatform 用户无权访问
'415':
description: 请求体必须为 application/json
/pb/api/attachment/detail:
post:
tags: [附件管理]
summary: 查询附件详情
description: |
仅允许 `ManagePlatform` 用户访问。
按 `attachments_id` 查询单条附件，并返回 PocketBase 文件流链接与下载链接。
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/AttachmentDetailRequest'
responses:
'200':
description: 查询成功
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ApiResponse'
- type: object
properties:
data:
$ref: '#/components/schemas/AttachmentRecord'
'400':
description: 参数错误
'401':
description: token 无效或已过期
'403':
description: 非 ManagePlatform 用户无权访问
'404':
description: 未找到对应附件
'415':
description: 请求体必须为 application/json
/pb/api/attachment/upload:
post:
tags: [附件管理]
summary: 上传附件
description: |
仅允许 `ManagePlatform` 用户访问。
使用 `multipart/form-data` 上传单个文件到 `tbl_attachments`，服务端会自动生成 `attachments_id`，
并返回可直接访问的 PocketBase 文件流链接。
requestBody:
required: true
content:
multipart/form-data:
schema:
$ref: '#/components/schemas/AttachmentUploadRequest'
responses:
'200':
description: 上传成功
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ApiResponse'
- type: object
properties:
data:
$ref: '#/components/schemas/AttachmentRecord'
'400':
description: 参数错误、缺少文件或附件保存失败
'401':
description: token 无效或已过期
'403':
description: 非 ManagePlatform 用户无权访问
/pb/api/attachment/delete:
post:
tags: [附件管理]
summary: 删除附件
description: |
仅允许 `ManagePlatform` 用户访问。
按 `attachments_id` 真删除附件；若附件已被 `tbl_document.document_image` 或 `document_video` 引用，则拒绝删除。
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/AttachmentDetailRequest'
responses:
'200':
description: 删除成功
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ApiResponse'
- type: object
properties:
data:
type: object
properties:
attachments_id:
type: string
'400':
description: 参数错误、附件已被文档引用或删除失败
'401':
description: token 无效或已过期
'403':
description: 非 ManagePlatform 用户无权访问
'404':
description: 未找到待删除附件
'415':
description: 请求体必须为 application/json
'429':
description: 重复请求过于频繁
/pb/api/document/list:
post:
tags: [文档管理]
summary: 查询文档列表
description: |
仅允许 `ManagePlatform` 用户访问。
支持按标题、摘要、关键词等字段模糊搜索，并可按 `document_status`、`document_type` 过滤。
返回结果会自动根据 `document_image`、`document_video` 关联 `tbl_attachments`，
额外补充 `document_image_url`、`document_video_url` 以及对应附件对象。
requestBody:
required: false
content:
application/json:
schema:
$ref: '#/components/schemas/DocumentListRequest'
responses:
'200':
description: 查询成功
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ApiResponse'
- type: object
properties:
data:
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/DocumentRecord'
'401':
description: token 无效或已过期
'403':
description: 非 ManagePlatform 用户无权访问
'415':
description: 请求体必须为 application/json
/pb/api/document/detail:
post:
tags: [文档管理]
summary: 查询文档详情
description: |
仅允许 `ManagePlatform` 用户访问。
按 `document_id` 查询单条文档，并返回与附件表联动解析后的文件流链接。
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/DocumentDetailRequest'
responses:
'200':
description: 查询成功
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ApiResponse'
- type: object
properties:
data:
$ref: '#/components/schemas/DocumentRecord'
'400':
description: 参数错误
'401':
description: token 无效或已过期
'403':
description: 非 ManagePlatform 用户无权访问
'404':
description: 未找到对应文档
'415':
description: 请求体必须为 application/json
/pb/api/document/create:
post:
tags: [文档管理]
summary: 新增文档
description: |
仅允许 `ManagePlatform` 用户访问。
`document_id` 可选；未传时服务端自动生成。
`document_image`、`document_video` 需传入已存在于 `tbl_attachments` 的 `attachments_id`。
成功后会同步写入一条 `tbl_document_operation_history`，操作类型为 `create`。
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/DocumentMutationRequest'
responses:
'200':
description: 新增成功
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ApiResponse'
- type: object
properties:
data:
$ref: '#/components/schemas/DocumentRecord'
'400':
description: 参数错误、附件不存在或文档创建失败
'401':
description: token 无效或已过期
'403':
description: 非 ManagePlatform 用户无权访问
'415':
description: 请求体必须为 application/json
'429':
description: 重复请求过于频繁
/pb/api/document/update:
post:
tags: [文档管理]
summary: 修改文档
description: |
仅允许 `ManagePlatform` 用户访问。
按 `document_id` 定位现有文档并更新；若传入 `document_image`、`document_video`，则必须是已存在的 `attachments_id`。
成功后会同步写入一条 `tbl_document_operation_history`，操作类型为 `update`。
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/DocumentMutationRequest'
responses:
'200':
description: 修改成功
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ApiResponse'
- type: object
properties:
data:
$ref: '#/components/schemas/DocumentRecord'
'400':
description: 参数错误、附件不存在或修改失败
'401':
description: token 无效或已过期
'403':
description: 非 ManagePlatform 用户无权访问
'404':
description: 未找到待修改文档
'415':
description: 请求体必须为 application/json
'429':
description: 重复请求过于频繁
/pb/api/document/delete:
post:
tags: [文档管理]
summary: 删除文档
description: |
仅允许 `ManagePlatform` 用户访问。
按 `document_id` 真删除文档，并在删除前同步写入一条 `tbl_document_operation_history`，操作类型为 `delete`。
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/DocumentDeleteRequest'
responses:
'200':
description: 删除成功
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ApiResponse'
- type: object
properties:
data:
type: object
properties:
document_id:
type: string
'400':
description: 参数错误或删除失败
'401':
description: token 无效或已过期
'403':
description: 非 ManagePlatform 用户无权访问
'404':
description: 未找到待删除文档
'415':
description: 请求体必须为 application/json
'429':
description: 重复请求过于频繁
/pb/api/document-history/list:
post:
tags: [文档历史]
summary: 查询文档操作历史
description: |
仅允许 `ManagePlatform` 用户访问。
若 body 传入 `document_id`，则仅查询该文档的历史；否则返回全部文档操作历史，按创建时间倒序排列。
requestBody:
required: false
content:
application/json:
schema:
$ref: '#/components/schemas/DocumentHistoryListRequest'
responses:
'200':
description: 查询成功
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ApiResponse'
- type: object
properties:
data:
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/DocumentHistoryRecord'
'401':
description: token 无效或已过期
'403':
description: 非 ManagePlatform 用户无权访问
'415':
description: 请求体必须为 application/json