Files
leaudit-platform-frontend/auth_doc/前端对接文档-API端点列表.md
T
2025-11-18 11:06:24 +08:00

4.9 KiB

API端点列表

PostgREST代理端点

所有PostgREST代理端点都位于 /api/v1/postgrest/{table_name}

支持的HTTP方法:GET, POST, PATCH, DELETE

文档管理模块

表名 端点 说明 所需权限
documents /api/v1/postgrest/documents 文档表 document:document:view/create/update/delete
document_types /api/v1/postgrest/document_types 文档类型(公共数据) document:type:view/create/update/delete
document_metadata /api/v1/postgrest/document_metadata 文档元数据 document:metadata:view/create/update/delete

评查管理模块

表名 端点 说明 所需权限
evaluation_results /api/v1/postgrest/evaluation_results 评查结果 evaluation:result:view/create/update/delete
evaluation_points /api/v1/postgrest/evaluation_points 评查点配置 evaluation:point:view/create/update/delete
evaluation_point_categories /api/v1/postgrest/evaluation_point_categories 评查点分类 evaluation:category:view/create/update/delete
evaluation_rules /api/v1/postgrest/evaluation_rules 评查规则 evaluation:rule:view/create/update/delete

交叉评查模块

表名 端点 说明 所需权限
cross_examination_tasks /api/v1/postgrest/cross_examination_tasks 交叉评查任务 crossreview:task:view/create/update/delete
cross_task_document_mapping /api/v1/postgrest/cross_task_document_mapping 任务-文档映射 crossreview:mapping:view/create/update/delete
cross_scoring_proposals /api/v1/postgrest/cross_scoring_proposals 评分提案 crossreview:proposal:view/create/update/delete
cross_proposal_votes /api/v1/postgrest/cross_proposal_votes 提案投票 crossreview:vote:view/create/update/delete

用户管理模块

表名 端点 说明 所需权限
sso_users /api/v1/postgrest/sso_users 用户表 system:user:view/create/update/delete
user_role /api/v1/postgrest/user_role 用户-角色关联 system:user_role:view/create/update/delete

系统管理模块

表名 端点 说明 所需权限
roles /api/v1/postgrest/roles 角色表 system:role:view/create/update/delete
sys_routes /api/v1/postgrest/sys_routes 系统路由(菜单) system:route:view/create/update/delete
role_route /api/v1/postgrest/role_route 角色-路由关联 system:role_route:view/create/update/delete

RBAC权限管理模块

表名 端点 说明 所需权限
permissions /api/v1/postgrest/permissions 权限定义 system:permission:view/create/update/delete
role_permissions /api/v1/postgrest/role_permissions 角色-权限关联 system:role_permission:view/create/update/delete
user_permissions /api/v1/postgrest/user_permissions 用户-权限关联 system:user_permission:view/create/update/delete
data_permission_rules /api/v1/postgrest/data_permission_rules 数据权限规则 system:data_rule:view/create/update/delete
permission_audit_logs /api/v1/postgrest/permission_audit_logs 权限审计日志 system:audit_log:view/create/update/delete
jwt_tokens /api/v1/postgrest/jwt_tokens JWT Token管理 system:jwt_token:view/create/update/delete

报表统计模块

表名 端点 说明 所需权限
statistics_summary /api/v1/postgrest/statistics_summary 统计汇总 report:summary:view/create/update/delete

FastAPI业务端点

认证端点

端点 方法 说明 认证
/api/v1/auth/login POST 用户登录
/api/v1/auth/logout POST 用户登出
/api/v1/auth/refresh POST 刷新Token

文档业务端点(示例)

端点 方法 说明 认证
/api/v1/documents/{id}/ocr POST 文档OCR处理
/api/v1/documents/{id}/merge POST 合并PDF文档
/api/v1/documents/{id}/extract POST AI提取信息

请求示例

GET请求示例

GET /api/v1/postgrest/documents?status=eq.active&limit=10&order=created_at.desc
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...

POST请求示例

POST /api/v1/postgrest/documents
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
Content-Type: application/json

{
  "title": "新文档",
  "content": "文档内容",
  "status": "draft"
}

PATCH请求示例

PATCH /api/v1/postgrest/documents?id=eq.1936
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
Content-Type: application/json

{
  "status": "reviewed"
}

DELETE请求示例

DELETE /api/v1/postgrest/documents?id=eq.1936
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...