aitori-bi-v2/doc/CONFIG_API.md

系统配置 API 文档

本文档描述系统配置 t_config 相关接口。

1. 基础信息

• URL 前缀: /v2/config
• 响应格式: 统一使用 GlobalResponseWrapper

---

2. 接口列表

2.1 获取全部配置

• URL: /list
• Method: GET
• 描述: 查询全部系统配置，默认按 configKey 升序返回。

请求参数

无

响应参数 (data 字段)

返回 TConfig 对象列表，元素结构如下：

字段名	类型	说明
configKey	string	配置 key，主键
configValue	string	配置值
remark	string	说明
createTime	string	创建时间，格式：yyyy-MM-dd HH:mm:ss
updateTime	string	更新时间，格式：yyyy-MM-dd HH:mm:ss

示例响应

{
  "code": 200,
  "message": "success",
  "data": [
    {
      "configKey": "site_name",
      "configValue": "Aitori BI",
      "remark": "站点名称",
      "createTime": "2026-03-25 10:00:00",
      "updateTime": "2026-03-25 10:00:00"
    }
  ]
}

2.2 分页查询配置

• URL: /page
• Method: GET
• 描述: 分页查询系统配置，支持按 configKey、configValue、remark 关键字模糊匹配。

请求参数

字段名	类型	必填	说明
page	integer	否	页码，默认 1
size	integer	否	每页大小，默认 10
keyword	string	否	关键字，支持配置 key / 配置值 / 说明模糊匹配

响应参数 (data 字段)

字段名	类型	说明
records	array	当前页配置列表
total	integer	总记录数
size	integer	每页数量
current	integer	当前页码
pages	integer	总页数

2.3 获取配置详情

• URL: /get/{configKey}
• Method: GET
• 描述: 根据配置 key 获取单个系统配置。

请求参数

字段名	类型	必填	说明
configKey	string	是	配置 key

响应参数 (data 字段)

返回单个 TConfig 对象，字段说明同“获取全部配置”。

2.4 新增配置

• URL: /add
• Method: POST
• Content-Type: application/json
• 描述: 新增一条系统配置。configKey 不能为空，且不能重复。

请求参数 (Body)

字段名	类型	必填	说明
configKey	string	是	配置 key，主键
configValue	string	否	配置值
remark	string	否	说明

请求示例

{
  "configKey": "site_name",
  "configValue": "Aitori BI",
  "remark": "站点名称"
}

响应参数

类型	说明
boolean	操作结果 (true/false)

2.5 更新配置

• URL: /update
• Method: PUT
• Content-Type: application/json
• 描述: 更新已存在的系统配置。configKey 不能为空，且必须已存在。

请求参数 (Body)

字段名	类型	必填	说明
configKey	string	是	配置 key，主键
configValue	string	否	配置值
remark	string	否	说明

响应参数

类型	说明
boolean	操作结果 (true/false)

2.6 删除配置

• URL: /delete/{configKey}
• Method: DELETE
• 描述: 根据配置 key 删除系统配置。

请求参数

字段名	类型	必填	说明
configKey	string	是	配置 key

响应参数

类型	说明
boolean	操作结果 (true/false)