Nebula Param 接口信息

本文档基于 nebula-param-local 中当前已经实现的 SystemParamController 整理，对外接口入口统一位于 /api/param/system-params/**。

说明约定：

• 所有接口返回统一 ApiResult
• 分页接口统一使用 POST
• 参数值最终都按字符串存储，但服务层会依据 dataType 执行校验与类型转换
• 批量更新接口更适合后台设置页一次提交多个参数值

---

1. 系统参数管理接口

创建系统参数

创建一个新的系统参数，同时保存参数元数据、数据类型和校验规则。

POST/api/param/system-params

请求体application/json

响应体

---

更新系统参数

更新指定系统参数的元数据、校验规则和当前参数值。

PUT/api/param/system-params/{id}

请求体application/json

响应体

---

删除系统参数

删除指定系统参数。当前实现使用软删除，并清理按 key 读取缓存。

DELETE/api/param/system-params/{id}

响应体

---

系统参数详情

根据系统参数 ID 查询详情。

GET/api/param/system-params/{id}

响应体

---

按参数键查询详情

根据参数键查询参数详情，更适合配置中心页面按 key 定位某项参数。

GET/api/param/system-params/key/{paramKey}/detail

响应体

---

分页查询系统参数

按参数键、名称、模块编码、数据类型和渲染开关等条件分页查询系统参数。

POST/api/param/system-params/page

请求体application/json

响应体

---

按模块编码查询参数列表

按模块编码加载一组可见参数，适合前端设置页渲染。当前结果会按 displayOrder 升序返回。

GET/api/param/system-params/module/{moduleCode}

响应体

---

2. 按键保存与批量更新接口

按参数键保存或更新系统参数

按 key 直接创建或更新一项系统参数，更适合模块内部程序化写入默认配置。

PUT/api/param/system-params/key/{paramKey}

请求体application/json

响应体

---

批量更新参数值

一次提交多个参数值，服务端逐项校验并返回每项更新结果。适合后台设置页“保存全部设置”。

POST/api/param/system-params/batch-update-values

请求体application/json

响应体

---

3. 按参数键读取接口

按参数键获取原始字符串值

根据参数键读取原始字符串值。若参数不存在，通常返回 null。

GET/api/param/system-params/key/{paramKey}

响应体

---

按参数键获取布尔值

根据参数键读取布尔型参数值。若底层值不是 true/false，将返回参数值不合法错误。

GET/api/param/system-params/key/{paramKey}/boolean

响应体

---

按参数键获取整数值

根据参数键读取整数型参数值。若底层值无法解析为整数，将返回参数值不合法错误。

GET/api/param/system-params/key/{paramKey}/integer

响应体