> 本文整理自平台文档 docs/wujies/1.x/api/open-endpoints.mdx,用于站点内容演示。
(https://console.wujies.cn/remote-apps/cms-assets/doc-ba280430b9ca-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 |
| hello | wujies/wujies-plugins/wujies-hello/.../hello/open/HelloDemoOpenController.java |
| exam | wujies/wujies-plugins/wujies-exam/.../exam/open/OpenExamController.java |
| gallery | wujies/wujies-plugins/wujies-gallery/.../gallery/open/ 下 3 个控制器 |
| mall | wujies/wujies-plugins/wujies-mall/.../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/1.x/advanced/plugin-runtime)。
---
平台(宿主)
### 站点配置
OpenWebsiteConfigController,类级 @SaIgnore。
| 路径 | 方法 | 说明 | 是否匿名 |
|---|---|---|---|
/open/{code}/config | GET | 读某个应用的站点配置。{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/list | GET | 公开公告分页 | 是 |
/open/system/message/{messageId} | GET | 公开公告详情 | 是 |
/open/system/message/latest | GET | 最新 N 条公开公告(首页滚动通知用)。limit 默认 3、上限 10,结果缓存 3 分钟 | 是 |
---
hello(示例应用)
HelloDemoOpenController,类级 @SaIgnore,前缀 /open/hello。 范例应用刻意不加权限注解,好让沙箱里不带 token 也能验通。
| 路径 | 方法 | 说明 | 是否匿名 |
|---|---|---|---|
/open/hello/greet | GET | 公开打招呼,参数 name 可省。用来确认开放链路 | 是 |
/open/hello/item/list | GET | 公开读示例数据。与管理端 GET /hello/item/list 是两条路径、同一个 service | 是 |
/open/hello/config-via-plugin | GET | 反面教材:演示"插件自己包一层读站点配置"。真实场景应直接调 /open/hello/config | 是 |
---
exam(考试)
OpenExamController,类级 @SaIgnore,前缀 /open/exam。考试实现就是这个插件的 bean,因此服务直接注入。
| 路径 | 方法 | 说明 | 是否匿名 |
|---|---|---|---|
/open/exam/plan/list | GET | 分页查询考试计划。不传状态时默认只出「已发布 + 已结束」 | 是 |
/open/exam/plan/{planId} | GET | 考试计划详情 | 是 |
/open/exam/notice/list | GET | 公开公告分页。走 SDK 的 PlatformMessageApi,宿主没提供该能力时返回空页而不是 500 | 是 |
它原先直接透出宿主 TableDataInfo(键是 rows / total),改走 SDK 契约后透出的是 PlatformMessagePage(键是 records / total)。调用方要按新键取值。
---
gallery(图床)
三个控制器都在 .../gallery/open/ 下,都是类级 @SaIgnore。
### 图片:/open/gallery/image
| 路径 | 方法 | 说明 | 是否匿名 |
|---|---|---|---|
/open/gallery/image/guest/upload | POST | 游客批量上传图片(multipart/form-data)。默认公开、不关联相册 | 是 |
/open/gallery/image/list | GET | 分页查询图片,只出「公开 + 启用」 | 是 |
/open/gallery/image/listByCategory/{categoryId} | GET | 按分类查图片 | 是 |
/open/gallery/image/listByAlbum/{albumId} | GET | 按相册查图片 | 是 |
/open/gallery/image/listByTags | GET | 按标签查图片,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/hot | GET | 热门图片(按浏览量),结果按查询条件缓存 3 分钟 | 是 |
| `/open/gallery/image/lates |
本文导览
(https://console.wujies.cn/remote-apps/cms-assets/doc-ba280430b9ca-guide.svg)


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