中国 帮助

开放接口清单

本页收录全部 /open/ 端点:宿主提供的 4 个,加各应用自己开放出来的 46 个,共 50 个。 内容来自源码,逐条对着控制器里的 @RequestMapping / @GetMapping / @PostMapping 抄的, 不

开放接口清单
封面

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

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

本页收录全部 /open/ 端点:宿主提供的 4 个,加各应用自己开放出来的 46 个,共 50 个**。

内容来自源码,逐条对着控制器里的 @RequestMapping / @GetMapping / @PostMapping 抄的, 不是从别处转述的:

来源文件
宿主(平台)wujies-platform/wujies-modules/wujies-system/.../controller/OpenWebsiteConfigController.java
宿主(平台)wujies-platform/wujies-modules/wujies-system/.../controller/OpenMessageController.java
helloplugins/wujies-hello-plugin/.../hello/open/HelloDemoOpenController.java
examplugins/wujies-exam-plugin/.../exam/open/OpenExamController.java
galleryplugins/wujies-gallery-plugin/.../gallery/open/ 下 3 个控制器
mallplugins/wujies-mall-plugin/.../mall/open/ 下 2 个控制器

通用约定

项说明
响应体统一 {code, msg, data},code=200 表示成功;分页端点直接返回分页结构(rows/total),没有信封
登录整段 /open/ 都免登录:靠每个开放控制器类级 @SaIgnore(/open/ 不在宿主 security.excludes 白名单里,别指望那层兜底)
租户/open/ 在 open-api.tenant.path-patterns 默认值里,由宿主的 OpenApiTenantInterceptor 按请求头把租户设进上下文;不设租户会查不到数据**
未安装端点只在该应用被装载时存在。没装的应用,它的 /open/<code>/** 就是 404 —— 不会留下"能路由、一调就报没装"的空壳
路径固定从宿主模块搬进插件的开放接口,路径一个字节都不变,C 端不用改调用地址

插件侧只要写一个类前缀为 /open/<app>/ 的控制器、类上加 @SaIgnore 就行, 不需要注册路由清单、不需要改宿主一行代码**。宿主的 AllUrlHandler 会同时收集 宿主与插件的 mapping,PluginRuntimeManager 在 load / unload 之后 refresh() —— 装了就进清单、卸了就出清单。完整机制见[插件运行时](/docs/wujies/5.x/platform/architecture/plugin-runtime)。

---

平台(宿主)

### 站点配置

OpenWebsiteConfigController,类级 @SaIgnore。

路径方法说明是否匿名
/open/{code}/configGET读某个应用的站点配置。{code} = sys_config.config_category,如 mall / gallery。除 logo / favicon / name / nameEn / backgroundImage / description / copyright / icp 八个基础字段外,其余 <code>.* 配置去掉前缀后原样放进 settings 透传是

这是一个泛化端点:归档的 5 个子类(enterprise / exam / gallery / im / mall)逐字看下来只差一个 category 常量, 所以用一个模板覆盖,新应用接进来不用改这个类 —— 应用侧只提供 sys_config 行(config_category = 应用编码)即可。

### 公开公告

OpenMessageController,类级 @SaIgnore,前缀 /open/system/message。

路径方法说明是否匿名
/open/system/message/listGET公开公告分页是
/open/system/message/{messageId}GET公开公告详情是
/open/system/message/latestGET最新 N 条公开公告(首页滚动通知用)。limit 默认 3、上限 10,结果缓存 3 分钟是

---

hello(示例应用)

HelloDemoOpenController,类级 @SaIgnore,前缀 /open/hello。 范例应用刻意不加权限注解,好让沙箱里不带 token 也能验通。

路径方法说明是否匿名
/open/hello/greetGET公开打招呼,参数 name 可省。用来确认开放链路是
/open/hello/item/listGET公开读示例数据。与管理端 GET /hello/item/list 是两条路径、同一个 service是
/open/hello/config-via-pluginGET反面教材:演示"插件自己包一层读站点配置"。真实场景应直接调 /open/hello/config是

---

exam(考试)

OpenExamController,类级 @SaIgnore,前缀 /open/exam。考试实现就是这个插件的 bean,因此服务直接注入。

路径方法说明是否匿名
/open/exam/plan/listGET分页查询考试计划。不传状态时默认只出「已发布 + 已结束」是
/open/exam/plan/{planId}GET考试计划详情是
/open/exam/notice/listGET公开公告分页。走 SDK 的 PlatformMessageApi,宿主没提供该能力时返回空页而不是 500是

它原先直接透出宿主 TableDataInfo(键是 rows / total),改走 SDK 契约后透出的是 PlatformMessagePage(键是 records / total)。调用方要按新键取值。

---

gallery(图床)

三个控制器都在 .../gallery/open/ 下,都是类级 @SaIgnore。

### 图片:/open/gallery/image

路径方法说明是否匿名
/open/gallery/image/guest/uploadPOST游客批量上传图片(multipart/form-data)。默认公开、不关联相册是
/open/gallery/image/listGET分页查询图片,只出「公开 + 启用」是
/open/gallery/image/listByCategory/{categoryId}GET按分类查图片是
/open/gallery/image/listByAlbum/{albumId}GET按相册查图片是
/open/gallery/image/listByTagsGET按标签查图片,tags 为逗号分隔的标签 ID是
/open/gallery/image/{imageId}GET图片详情。会异步增加浏览量并记一条访问日志;非公开或非启用返回失败是
/open/gallery/image/view/{imageId}POST增加浏览量(Redis 计数器 + 异步日志)是
/open/gallery/image/like/{imageId}POST增加点赞数是
/open/gallery/image/unlike/{imageId}POST取消点赞是
/open/gallery/image/download/{imageId}POST增加下载次数是
/open/gallery/image/hotGET热门图片(按浏览量),结果按查询条件缓存 3 分钟是
`/open/gallery/image/lates

本文导览

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

章节导览
THE END

喜欢就支持以下吧

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

回到内容