Skip to content

开放平台

开放平台是 Forge Admin 的统一能力开放入口:把系统内的业务动作、流程动作、系统服务等封装为「能力」,经过注册、版本发布、客户端授权后,供外部系统通过标准协议安全调用。

后端能力由 forge-plugin-capability-parent(能力模型与控制面)与 forge-starter-openapi-security(OAuth2 / HMAC 开放网关)提供,网关内置限流、幂等、调用审计与在线测试。

功能入口

登录管理后台后,点击左侧菜单 开放平台,包含两个页签:

页签作用
能力目录注册、发布、查看可供外部调用的开放能力
机器客户端管理外部系统接入所需的客户端凭据

能力目录

能力目录列出系统内已注册的开放能力,字段如下:

说明
能力编码能力的唯一标识,如 business.hr.leave_application.submit
能力名称如「提交离职申请申请」
来源类型业务动作 / 流程动作 / 系统服务 / 业务对象
当前版本能力版本号,如 1.0.2
风险等级低 / 中 / 高风险(高风险动作需额外审批)
调用主体用户委托 / 服务身份 / 混合模式
可见性可发现 / 私有
发布状态已发布 / 草稿等

能力目录列表

支持按 能力编码 / 名称发布状态 筛选;行内提供「调用与测试 / 发布新版本 / 更多」操作。

注册能力

点击 注册能力,填写:

字段必填说明
能力类型业务动作 / 流程动作 / 系统服务 / 业务对象
业务对象条件选择已发布的业务对象(业务动作 / 流程动作需要)
业务动作条件选择可开放的业务动作
允许字段选择外部调用可以写入的字段
必填字段必须属于允许字段
能力编码business.order.create
能力版本能力版本号
能力描述能力说明

注册开放能力

机器客户端

机器客户端是外部系统调用开放能力的接入凭据,字段如下:

说明
客户端编码客户端唯一编码,如 erp-sync
客户端名称显示名称
客户端 ID / AppId网关生成的客户端标识
凭据前缀凭据脱敏前缀
认证模式OAuth 凭据 / HMAC
主体模式用户委托 / 服务身份 / 混合模式
密钥版本 / 签名密钥版本当前使用的密钥版本
状态启用 / 停用
过期时间凭据有效期,到期后认证立即失效
最近调用最近一次调用时间
创建时间创建时间

机器客户端列表

新增客户端

点击 新增客户端,填写:

字段必填说明
客户端编码erp-sync,创建后不可修改,作为外围系统的稳定标识
客户端名称显示名称
主体模式用户委托(真实操作人)/ 服务身份(后台任务)/ 混合模式
认证模式OAuth 凭据(标准 Token 接入)/ HMAC(服务间签名调用)
过期时间不填则长期有效;生产建议设置有效期并定期轮换凭据
备注说明

新增能力客户端

调用与测试

能力发布、客户端创建后,可在能力目录行内点击 调用与测试,系统提供:

  • 在线调用测试,验证鉴权、参数与返回结果。
  • 调用指南(协议说明、请求示例)。
  • 调用审计(调用时间、主体、结果)。

注意事项

  • 高风险动作(如资金、权限变更)默认关闭,需显式配置版本化 KEK 并经过审批后开放。
  • 客户端凭据到期后所有认证立即失效,生产环境建议设置有效期并定期轮换。
  • 客户端编码、密钥等敏感信息脱敏显示,禁止明文落库或打印到日志。
  • 能力「发布新版本」后,旧版本调用是否兼容请参考版本策略,避免存量集成中断。

相关文档

Forge Admin — 基于 Vue3 + Spring Boot 的企业级后台管理框架