中国 帮助

API 手册

这一册收的是跨边界的稳定面:平台对外、平台与插件、宿主与远程应用之间, "约定好了就不该随便改"的那些接口。全部对着源码写,不转述二手结论。 这一册包含什么 分册 内容 谁要看 [开放接口清单](/docs/w

API 手册
封面

> 本文整理自平台文档 docs/wujies/5.x/platform/open-api/index.mdx,用于站点内容演示。

(https://console.wujies.cn/remote-apps/cms-assets/doc-d3674655c1c5-cover.svg)

这一册收的是跨边界的稳定面:平台对外、平台与插件、宿主与远程应用之间, "约定好了就不该随便改"的那些接口。全部对着源码写,不转述二手结论。

这一册包含什么

分册内容谁要看
[开放接口清单](/docs/wujies/5.x/platform/open-api/endpoints)全部 /open/** 端点共 50 个(宿主 4 + 各应用 46):路径 / 方法 / 说明 / 是否匿名C 端与第三方调用方;要开放自己接口的插件作者
[平台 SDK 契约](/docs/wujies/5.x/platform/plugin/sdk)wujies-common-plugin-sdk 的 36 个类:11 个能力接口、22 个值对象、3 个定位器用平台能力的插件作者;提供实现的平台侧
[定位器](/docs/wujies/5.x/platform/architecture/locators)宿主反过来调插件服务的两条路,PluginServiceProvider / PluginServiceLocator 与会员 / 支付 / IM 三个薄包装宿主侧要调插件服务的人;做跨插件调用的插件作者
[前端运行时 API](/docs/wujies/5.x/frontends/runtime)远程应用通过 install(runtime) 拿到的运行时字段,以及 manifest / views 的返回约定写远程应用前端的人

与「HTTP 接口索引」的分工

两页都会出现 HTTP 端点,但收的不是同一批:

[API 手册](/docs/wujies/5.x/platform/open-api/)(本册)[HTTP 接口索引](/docs/wujies/5.x/platform/reference/api)
范围跨边界稳定面:/open/**、SDK 类、定位器、前端运行时宿主管理端全量端点(/app/**,38 个)
视角别人要依赖什么平台自己提供什么
改动代价改了就会破坏已发布的插件或已在跑的 C 端改了只影响本平台的前端

三条使用前提

整段 /open/ 都免登录(靠控制器类上的 @SaIgnore;/open/ 并不在宿主 security.excludes 里), 而插件自己的管理端接口同样过鉴权(插件路由挂了宿主的拦截器链,见 [插件运行时](/docs/wujies/5.x/platform/architecture/plugin-runtime))—— 插件接口不会"裸奔"。

插件用 ObjectProvider.getIfAvailable() 取 SDK 里的能力接口,取不到就降级。 强注入会把"宿主缺少该能力(例如平台裁剪版)"变成启动失败, 而插件能降级运行才是这套契约存在的意义。

components 组件的 props、request 的调用形态、SDK 接口的方法签名,改了就会破坏已发布的包。 要加就新增,不要改既有签名;SDK 里加字段前还要确认调用方真的在用 (MemberProfileView 的类注释专门写了这一条:加了没人用,就是无声的 undefined)。

建议阅读顺序

1. 先看[开放接口清单](/docs/wujies/5.x/platform/open-api/endpoints)的「通用约定」与平台那一节 —— 站点配置与公开公告是两个 所有应用都会用到、且不需要应用自己写代码的端点; 2. 再按你正在做的事挑:写插件后端看[平台 SDK 契约](/docs/wujies/5.x/platform/plugin/sdk), 宿主侧要调插件服务看[定位器](/docs/wujies/5.x/platform/architecture/locators),写插件前端看[前端运行时 API](/docs/wujies/5.x/frontends/runtime); 3. 想知道这些能力在运行期怎么装配起来,回到[插件运行时](/docs/wujies/5.x/platform/architecture/plugin-runtime)。

相关阅读

  • [插件开发](/docs/wujies/5.x/platform/plugin/) —— 从零做一个应用的五步
  • [必须遵守的不变量](/docs/wujies/5.x/platform/plugin/basics/invariants) —— 改代码前扫一遍
  • [HTTP 接口索引](/docs/wujies/5.x/platform/reference/api) —— 宿主管理端接口
  • [配置项索引](/docs/wujies/5.x/deploy/configuration) —— 上面这些行为受哪些配置控制

本文导览

(https://console.wujies.cn/remote-apps/cms-assets/doc-d3674655c1c5-guide.svg)

章节导览
THE END

喜欢就支持以下吧

评论区需要浏览器启用 JavaScript 才能加载。

回到内容