系统配置接口
接口列表
| 接口 | 方法 | 说明 |
|---|---|---|
/api/v1/configs | GET | 获取配置列表 |
/api/v1/configs/{configKey} | GET | 获取指定配置项 |
/api/v1/configs | POST | 新增配置项 |
/api/v1/configs/{configKey} | PUT | 修改配置项 |
/api/v1/configs/{configKey} | DELETE | 删除配置项 |
获取配置列表
http
GET /api/v1/configs?pageNum=1&pageSize=10
Authorization: Bearer {accessToken}响应示例:
json
{
"code": "00000",
"message": "成功",
"data": {
"total": 15,
"list": [
{
"id": 1,
"configKey": "sys.user.initPassword",
"configValue": "123456",
"configName": "用户初始密码",
"remark": "新建用户时的默认密码"
}
]
}
}获取指定配置项
http
GET /api/v1/configs/sys.user.initPassword
Authorization: Bearer {accessToken}响应示例:
json
{
"code": "00000",
"message": "成功",
"data": {
"configKey": "sys.user.initPassword",
"configValue": "123456",
"configName": "用户初始密码",
"remark": "新建用户时的默认密码"
}
}新增配置项
http
POST /api/v1/configs
Authorization: Bearer {accessToken}
Content-Type: application/json
{
"configKey": "sys.upload.maxSize",
"configValue": "10",
"configName": "上传文件大小限制",
"remark": "单位:MB"
}配置项字段说明
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| configKey | string | ✅ | 配置键(唯一) |
| configValue | string | ✅ | 配置值 |
| configName | string | ✅ | 配置名称 |
| remark | string | ❌ | 备注 |
系统预置配置
| 配置键 | 默认值 | 说明 |
|---|---|---|
sys.user.initPassword | 123456 | 新用户初始密码 |
sys.upload.maxSize | 10 | 上传文件大小上限(MB) |
sys.upload.allowTypes | jpg,png,pdf | 允许的文件类型 |
sys.login.maxRetry | 5 | 登录最大重试次数 |
sys.login.lockTime | 30 | 账户锁定时长(分钟) |
配置缓存
系统配置会被缓存到 Redis:
- 缓存键:
sys:config:{configKey} - 缓存时长:永久(直到手动更新)
- 刷新策略:修改配置后自动刷新
权限要求
| 操作 | 权限标识 |
|---|---|
| 查看 | sys:config:list |
| 新增 | sys:config:add |
| 修改 | sys:config:edit |
| 删除 | sys:config:delete |
