Skip to content

API 文档总览 ​

系统接口分两类:

对外开放 API ​

以 MCP 协议(Streamable HTTP + JSON-RPC 2.0)把系统只读工具能力对外暴露,供外部系统集成调用。外部系统使用专用令牌 + 代理主体鉴权,不依赖本平台登录态。

→ 对外开放 API(MCP)

内部 API ​

系统前端与后端之间的 REST 接口,按模块划分:

模块路径前缀说明
数据洞察/office/**AI 问答、数据分析、线索挖掘、数据表配置、模板、上传、大屏
AI 底座/ai/**模型接入、场景试运行、Agent 工具 / 技能、MCP 接入
监督模型/sup/**模型分类、模型管理、监督分析
培训考试/train/**题库、考试、阅卷、培训中心、刷题 / 复习
系统管理/system/**用户、角色、菜单、部门、字典、通知、参数
监控/monitor/**缓存、在线用户、操作日志、登录日志、服务器
公共/common/**上传 / 下载
认证与入口/login /register /captcha /登录、验证码、注册、首页

权限码说明:每个接口标注其所需权限码。hasPermi('x') 表示需具备 x 权限;hasAnyPermi('a,b') 表示 a 或 b 任一即可。

通用约定 ​

  • 认证:内部接口走平台 JWT(Authorization: Bearer <token>),登录接口获取;
  • 分页:pageNum / pageSize 为顶层字段;筛选条件通常走 params[xxx] 扁平键;
  • 数据权限:带归属的数据查询由后端 @DataScope 自动按角色数据权限过滤。

数智洞察平台