中国 帮助

HTTP 接口索引

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

HTTP 接口索引
封面

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

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

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

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

  • wujies-modules/wujies-app-market/.../controller/ 下的 9 个 *Controller;
  • 目录服务接口 catalog/AppCatalogApiController(注意它在 catalog/ 包,不在 controller/ 包);
  • 路径与请求头常量 catalog/CatalogApiContract;
  • 业务码契约 wujies-common-core 的 plugin/AppRouteHintProvider。

通用约定

项说明
响应体统一为 {code, msg, data},code=200 表示成功。例外:/app/catalog/** 直接返回业务对象,无信封(见下文)
登录除 /app/catalog/**(在 security.excludes 里)外,所有端点都在登录拦截范围内,未带会话返回 code=401
权限由方法上的 @SaCheckPermission("...") 声明;下表「权限」列写的就是注解里的字符串
租户安装实例类接口一律作用于当前登录者的租户;只有超级管理员能通过 tenantId 参数指定别的租户
版本形态app-market.edition=client(用户版)时,上架端前缀一律被 MarketEditionGuardFilter 拦成 403

### 分组速览

分组路径前缀端点数
市场浏览(安装侧)/app/market3
应用上架(上架端)/app/console7
应用分类/app/category5
版本与安装包/app/version、/app/package9
安装、升级与卸载(安装侧)/app/install10
运行时答复(宿主前端)/app/runtime、/app/edition3
工作台/app/workbench1
目录服务(服务间)/app/catalog9
菜单归属/app/console1
合计48

市场浏览(安装侧)

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、清单原文、制品直链)

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

GET /app/version/list 挂的是 app:console:list,并直接返回 AppVersion 实体(含签名、校验和、清单原文、包直链)。租户侧只能用本节的 /app/market/{appCode}/versions。

应用上架(上架端)

AppConsoleController,前缀 /app/console。面向平台运营,维护应用目录 app_info。

方法路径权限说明
GET/app/console/listapp:console:list应用列表(含草稿与已下架);可选 appName、appCode(模糊)、status
GET/app/console/signature-readinessapp:console:list签名就绪度自检:能否把 security.mode 切到 enforce;会真实下载已发布包(上限 100),属按需调用的诊断接口
GET/app/console/{appId}app:console:list应用详情
POST/app/consoleapp:console:add新增应用(默认落草稿 status=0;installMode 默认 optional、audience 默认 tenant)
PUT/app/consoleapp:console:edit修改应用;latestVersion 不接受前端传值
POST/app/console/{appId}/statusapp:console:edit上架 / 下架 / 退回草稿(status = 1 / 2 / 0)
DELETE/app/console/{appId}app:console:remove删除应用;系统应用与已上架应用一律拒绝,默认只有 demo-app 在白名单里

两处硬约束:

  • 上架前必须至少有一个已发布版本(latest_version 非空),否则报「应用尚未发布任何版本,无法上架」;
  • appId/status 变更会整片失效菜单缓存,因为「已上架数量」决定菜单过滤是否启用。

GET /app/console/owned-menus 也在这个前缀下,但用途是菜单归属,列在「菜单归属」一节。

应用分类

AppCategoryController,前缀 /app/category。分类是全局表(在 tenant.excludes 中)。

方法路径权限说明
GET/app/category/listapp:category:list分类列表(平铺返回,前端用 handleTree 组树);可选 categoryName、status
GET/app/category/{categoryId}app:category:list分类详情
POST/app/categoryapp:category:add新增分类;同层名称唯一
PUT/app/categoryapp:category:edit修改分类;父级不能是自己
DELETE/app/category/{categoryId}app:category:remove删除分类(逻辑删除);存在子分类时拒绝

读接口不是上架端专属:市场页要用 GET /app/category/list 做筛选,所以用户版(edition=client)只拦这里的两条写方法。

版本与安装包

版本的维护与发布在 AppVersionController(前缀 /app/version),安装包解析上传在 AppPackageController(前缀 /app/package)。

方法路径权限说明
GET/app/version/listapp:console:list某应用的全部版本;必填 appId;返回裸实体(含签名与校验和)
GET/app/version/{versionId}app:console:list版本详情
POST/app/versionapp:console:add新增版本(草稿 status=0);保存时即校验 manifestJson,并以清单回填 engineRange / version
PUT/app/versionapp:console:edit修改版本;已发布版本的清单不允许改(要改请发新版本)
POST/app/version/{versionId}/publishapp:console:edit发布版本,并把它回写为该应用的 latest_version
POST`/app/version/{versionId}/depre

本文导览

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

章节导览
THE END

喜欢就支持以下吧

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

回到内容