RESTful API 参考¶

本文档基于源码驱动，取代旧版 Apifox HTML 文档，提供天翎 myApps 平台各模块 RESTful API 的完整参考。

服务与基址¶

模块	服务端口	基址路径	说明
runtime	8083	`/api/rest`	运行时服务，context-path 占位：`${myapps.context-path.runtime:}`
designer	8082	`/api/rest`	设计器服务
kms	8084	`/api/rest`	知识管理服务
signon	8085	`/api/rest`	单点登录服务
manager	8087	`/api/rest`	管理控制台服务
gateway	8080	—	API 网关（统一路由入口，非 REST 资源提供者）

说明：各业务模块的 REST 基址为「该模块 context-path + /api/rest」，context-path 占位符（如 ${myapps.context-path.runtime:}）在部署时被替换为具体应用上下文路径；网关除外。

统一认证（accessToken）¶

获取令牌¶

GET /api/rest/accessToken?secret=<秘钥> HTTP/1.1

响应：

{
  "errcode": 0,
  "errmsg": "success",
  "data": {
    "accessToken": "生成的访问令牌"
  },
  "errors": null
}

使用令牌¶

除 GET /accessToken 外，所有 /rest/ 路径下的接口均需通过 query 参数 accessToken 传递访问令牌：

GET /api/rest/xxx?accessToken=<令牌>&... HTTP/1.1

执行用户¶

通过 query 参数 userCode 指定执行用户：

GET /api/rest/xxx?accessToken=<令牌>&userCode=<用户编码>&... HTTP/1.1

豁免路径¶

以下路径不需要 accessToken： - /api/rest/accessToken（令牌获取接口自身） - /login - /dingdingLogin - /synchronization - /sync - /macro - /clear - /pages/ - /showjrxml - /getCustomColumnsInfos - 带有 feignApi 请求头的调用

统一响应结构 Resource¶

所有 RESTful API 接口返回统一的 Resource 结构：

{
  "errcode": 0,
  "errmsg": "success",
  "data": <任意类型>,
  "errors": null
}

字段	类型	说明
errcode	int	0=成功；非 0=失败码
errmsg	string	描述信息
data	object/null	业务数据
errors	array/null	错误明细集合，通常为 null

成功示例：

{
  "errcode": 0,
  "errmsg": "success",
  "data": {
    "id": "文档ID",
    "name": "文档名称"
  },
  "errors": null
}

失败示例：

{
  "errcode": 404,
  "errmsg": "资源未找到",
  "data": null,
  "errors": null
}

错误码表¶

errcode	HTTP	含义
0	200	成功
404	404	资源未找到
500	500	服务器错误
40035	406	不合法的参数
406	406	请求包体参数出错
40001	200	Open API 调用秘钥错误（仅 /accessToken）
50001	500	流程异常

接口类型说明¶

本文档涵盖两种接口类型：

REST 资源接口：由 @RestController 或 @Controller（produces=APPLICATION_JSON_VALUE）提供，返回 JSON 格式的 Resource 结构。
页面视图接口：由 @Controller 提供，返回 HTML 页面。

两类接口均在收录范围，按端点的「接口类型」字段区分。本试点（runtime/rest 集成 API）仅含 REST 资源接口；页面视图接口将在对应模块文档中以「接口类型：页面视图」标注收录。

模块导航¶

模块	状态	文档路径
runtime	✅ 已就绪（52 控制器 / 315 端点）	runtime/
designer	✅ 已就绪（44 控制器 / 289 端点）	designer/
signon	✅ 已就绪（3 控制器 / 27 端点）	signon/
kms	✅ 已就绪（39 控制器 / 200 端点）	kms/
manager	✅ 已就绪（28 控制器 / 177 端点）	manager/
message	✅ 已就绪（5 控制器 / 31 端点）	message/
usercenter	✅ 已就绪（13 控制器 / 118 端点）	usercenter/
report	✅ 已就绪（1 控制器 / 5 端点）	report/
ai	✅ 已就绪（5 控制器 / 19 端点）	ai/
converter	✅ 已就绪（2 控制器 / 6 端点）	converter/
job	✅ 已就绪（1 控制器 / 7 端点）	job/
logger	✅ 已就绪（1 控制器 / 3 端点）	logger/

注：本文档随源码持续更新。旧版 Apifox HTML（app / cloudcenter / designer / kms / manager / message / runtime / signon / usercenter）已清退，以本目录 Markdown 为准。