跳到主要内容

Nebula Frontend 接口信息

本文档基于 nebula-frontend-local 中当前已经实现的 FrontendController 整理,对外接口入口统一位于 /api/frontend/**

说明约定:

  • 所有接口返回统一 ApiResult
  • 配置类接口主要面向平台管理员和后台设置页
  • 偏好类接口面向当前登录用户
  • 缓存管理接口面向 DynamicCacheService 管理的动态缓存

1. 初始化与配置接口

获取前端初始化配置

返回前端启动所需的一次性初始化数据,包含平台配置、登录配置、默认偏好和默认主题。
GET/api/frontend/init

获取前端配置

获取平台级前端配置,主要用于后台配置页面回显。
GET/api/frontend/config

保存前端配置

保存平台级前端配置,会把项目名称、默认主题、默认语言等配置写入参数中心。
PUT/api/frontend/config

获取主题目录

获取当前支持的主题列表以及主题配置项定义。
GET/api/frontend/themes

2. 用户偏好接口

切换语言

为当前登录用户切换语言偏好。若未在可选语言列表中,将返回语言配置不合法错误。
PUT/api/frontend/preferences/locale

切换主题

为当前登录用户切换主题偏好。主题编码必须存在于内置主题目录中。
PUT/api/frontend/preferences/theme

切换导航和侧边菜单布局

为当前登录用户切换导航布局和侧边栏布局。布局编码必须落在系统支持的受控集合内。
PUT/api/frontend/preferences/layout

3. 动态缓存管理接口

查看动态缓存

查看当前所有动态缓存分组、缓存项及其 TTL 信息。返回值面向后台缓存治理页。
GET/api/frontend/caches

删除动态缓存项

按缓存名称和缓存键精确删除一条动态缓存。只允许删除已注册缓存名称中的条目。
DELETE/api/frontend/caches/entries