Skip to content

系统配置接口

接口列表

接口方法说明
/api/v1/configsGET获取配置列表
/api/v1/configs/{configKey}GET获取指定配置项
/api/v1/configsPOST新增配置项
/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"
}

配置项字段说明

字段类型必填说明
configKeystring配置键(唯一)
configValuestring配置值
configNamestring配置名称
remarkstring备注

系统预置配置

配置键默认值说明
sys.user.initPassword123456新用户初始密码
sys.upload.maxSize10上传文件大小上限(MB)
sys.upload.allowTypesjpg,png,pdf允许的文件类型
sys.login.maxRetry5登录最大重试次数
sys.login.lockTime30账户锁定时长(分钟)

配置缓存

系统配置会被缓存到 Redis:

  • 缓存键:sys:config:{configKey}
  • 缓存时长:永久(直到手动更新)
  • 刷新策略:修改配置后自动刷新

权限要求

操作权限标识
查看sys:config:list
新增sys:config:add
修改sys:config:edit
删除sys:config:delete

基于 MIT 许可发布 · 由 ❤️ 和 ☕ 驱动 · 支持作者