中国 帮助

HTTP 接口索引

本页收录「应用市场」模块对外暴露的全部 HTTP 端点,按用途分组。 来源是源码本身,不是约定: wujiesmodules/wujiesappmarket/.../controller/ 下的 5 个 Controller; wu

HTTP 接口索引
封面

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

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

本页收录「应用市场」模块对外暴露的全部 HTTP 端点,按用途分组。

来源是源码本身,不是约定:

  • wujies-modules/wujies-app-market/.../controller/ 下的 5 个 *Controller;
  • wujies-modules/wujies-market-core/.../catalog/ 的 AppCatalogApiController(路径与请求头常量都在 CatalogApiContract,服务端与调用方共用一份);
  • 业务码契约 wujies-common-core 的 plugin/AppRouteHintProvider。

「应用 / 分类 / 版本 / 安装包」的维护接口原先挂在 /app/console、/app/category、/app/version、/app/package 四个前缀下,2026-10-31 起整套搬进了中心上架服务(另一个仓库,不在本开源仓库里)。本部署只读目录、只装应用,所以本页没有那些端点 —— 照着旧文档去调就是 404。 搬过来时留了三件在平台,判据是「读不读目录表」:产物落位、菜单归属查询、签名就绪度自检读的都是本部署自己的东西(宿主磁盘、app_version_menu、已下载过的包),现在都在 /app/install 下。

通用约定

项说明
响应体统一为 {code, msg, data},code=200 表示成功
登录所有端点都在登录拦截范围内,未带会话返回 code=401
权限由方法上的 @SaCheckPermission("...") 声明;下表「权限」列写的就是注解里的字符串
租户安装实例类接口一律作用于当前登录者的租户;只有超级管理员能通过 tenantId 参数指定别的租户
例外/app/catalog/ 是服务间接口:路径在 security.excludes 里放行(调用方是另一个部署,没有本机会话),改用请求头 X-Catalog-Token 认调用方,成功时不套** R 信封 —— 三条理由见下文专节

### 分组速览

分组路径前缀端点数
市场浏览(安装侧)/app/market4
安装、升级与卸载(安装侧)/app/install13
运行时答复(宿主前端)/app/runtime2
工作台/app/workbench1
插件开发台/app/dev18
目录服务(服务间)/app/catalog11
合计49

/app/dev 那 18 个只在开发模式开关打开时存在(@ConditionalOnProperty),线上部署里它们连路由都没注册,不是「存在但报 403」。/app/catalog 那 11 个只在「本部署是目录所有者」时注册 —— 判据只看 yml 里的 app-market.catalog.base-url 是否为空白。

市场浏览(安装侧)

AppMarketController,前缀 /app/market。只读接口:逛市场与看详情,安装动作在 /app/install。

数据不读本地目录表,而是走 IAppCatalogService —— 安装侧读目录只有这一个入口。

方法路径权限说明
GET/app/market/listapp:market:list已上架应用列表;可选 keyword(匹配名称或编码)、categoryId;单次上限 200 条
GET/app/market/{appCode}app:market:list应用详情;不校验上架状态(已下架应用的详情页仍要能打开)
GET/app/market/{appCode}/versionsapp:market:list该应用的已发布版本列表(新版本在前),字段经 AppVersionPublicVo 脱敏(无签名、MD5/SHA256、清单原文、制品直链)
GET/app/market/{appCode}/dependenciesapp:market:list最新已发布版本的依赖现状:逐个依赖带「已安装 / 未安装 / 已停用」状态,外加 allowed + message 结论;可选 versionId(升级确认场景指定版本)

可见范围由登录身份解析,不由前端传:超级管理员不限;C 端用户(APP_USER)对应 member;其余 B 端用户对应 tenant。

依赖判定要读本租户的安装台账,与「应用详情」是两种数据,所以单开一个接口而不是往详情里塞一个字段 —— 前端在详情页与详情、版本列表并发取,它失败只影响依赖区,不该因为目录抖动把整页拖没。

中心上架服务的 GET /app/version/list 返回 AppVersion 实体(含签名、MD5/SHA256、清单原文、制品直链),那是给运营用的。本部署已经没有那个接口了,租户侧只有本节的 /app/market/{appCode}/versions。

安装、升级与卸载(安装侧)

AppInstallController,前缀 /app/install。安装 / 启用 / 停用 / 卸载都返回任务 ID,进度与日志经任务中心查询。

方法路径权限说明
POST/app/installapp:install:add安装应用;请求体 AppInstallBo(appCode,超管可带 tenantId);返回任务 ID
GET/app/install/mineapp:install:list本租户已安装应用;带 statusLabel、upgradable 与 developing 标记
POST/app/install/{installId}/upgradeapp:install:edit升级;可选 versionId,不传则升到最新已发布版本
POST/app/install/{installId}/enableapp:install:edit启用(重新加载插件)
POST/app/install/{installId}/disableapp:install:edit停用(unload;保留数据与授权)
POST/app/install/{installId}/uninstallapp:install:edit卸载;purge 默认 false(保留数据),purge=true 彻底删除且不可恢复
POST/app/install/{installId}/sync-menusapp:install:edit重新同步该安装实例的菜单(幂等);用于修复 app_version_menu 漂移
GET/app/install/task/{taskId}app:install:list单个任务详情(含进度、步骤与日志正文);taskId 只匹配数字
GET/app/install/task/listapp:install:list任务中心分页列表;不含日志正文,只给状态 / 进度 / 当前步骤 / 耗时
DELETE/app/install/task/{taskId}app:install:edit删除一条任务记录
POST/app/install/version/{versionId}/deployapp:install:edit产物落位:按目录里的版本 ID 解包,把前后端产物释放到本部署的运行目录;不经迁移、不跑菜单同步
GET/app/install/owned-menussystem:menu:list受应用托管的菜单清单:{menuId, appCode, appName},按 menuId 升序
GET/app/install/signature-readinessapp:install:list签名就绪度自检:能否把 app-market.security.mode 切到 enforce;会真实下载已发布包(上限 100),属按需调用的诊断接口,别做成定时任务
// POST /app/install 请求体(AppInstallBo)
{ "appCode": "gallery", "tenantId": null }

upgradable 的确切含义是「目录里的 latest_version 与本行 version 字符串不等」,而开发台本地装的实

本文导览

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

章节导览
THE END

喜欢就支持以下吧

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

回到内容