Skip to content

系统设置 API

获取设置列表

http
GET /api/admin/settings
Authorization: Bearer {token}

查询参数

参数类型说明
groupstring分组名称

响应示例

json
{
    "code": 200,
    "message": "success",
    "data": {
        "site": {
            "title": "管理系统",
            "logo": "/logo.png",
            "copyright": "© 2024"
        },
        "email": {
            "smtp_host": "smtp.example.com",
            "smtp_port": 587
        }
    }
}

错误响应

401 未认证

json
{
    "code": 401,
    "message": "未认证",
    "data": null
}

403 无权限

json
{
    "code": 403,
    "message": "无权限访问",
    "data": null
}

获取分组设置

http
GET /api/admin/settings/{group}
Authorization: Bearer {token}

响应示例

json
{
    "code": 200,
    "message": "success",
    "data": {
        "title": "管理系统",
        "logo": "/logo.png"
    }
}

错误响应

401 未认证

json
{
    "code": 401,
    "message": "未认证",
    "data": null
}

403 无权限

json
{
    "code": 403,
    "message": "无权限访问",
    "data": null
}

创建设置

http
POST /api/admin/settings
Authorization: Bearer {token}
Content-Type: application/json

请求参数

参数类型必填说明
keystring设置键
valuemixed设置值
groupstring分组,默认 default
typestring类型:string, number, boolean, json

响应示例

json
{
    "code": 200,
    "message": "创建成功",
    "data": {
        "id": 1,
        "key": "site.title",
        "value": "新标题"
    }
}

错误响应

401 未认证

json
{
    "code": 401,
    "message": "未认证",
    "data": null
}

403 无权限

json
{
    "code": 403,
    "message": "无权限访问",
    "data": null
}

422 验证失败

json
{
    "code": 422,
    "message": "验证失败",
    "data": {
        "errors": {
            "key": ["键不能为空"],
            "value": ["值不能为空"]
        }
    }
}

批量更新设置

http
PUT /api/admin/settings
Authorization: Bearer {token}
Content-Type: application/json

请求参数

参数类型必填说明
settingsobject设置键值对

请求示例

json
{
    "settings": {
        "site.title": "新标题",
        "site.logo": "/new-logo.png"
    }
}

响应示例

json
{
    "code": 200,
    "message": "更新成功",
    "data": null
}

错误响应

401 未认证

json
{
    "code": 401,
    "message": "未认证",
    "data": null
}

403 无权限

json
{
    "code": 403,
    "message": "无权限访问",
    "data": null
}

422 验证失败

json
{
    "code": 422,
    "message": "验证失败",
    "data": {
        "errors": {
            "settings": ["设置不能为空"]
        }
    }
}

删除设置

http
DELETE /api/admin/settings/{id}
Authorization: Bearer {token}

响应示例

json
{
    "code": 200,
    "message": "删除成功",
    "data": null
}

错误响应

401 未认证

json
{
    "code": 401,
    "message": "未认证",
    "data": null
}

403 无权限

json
{
    "code": 403,
    "message": "无权限访问",
    "data": null
}

404 资源不存在

json
{
    "code": 404,
    "message": "资源不存在",
    "data": null
}

刷新设置缓存

http
POST /api/admin/settings/refresh
Authorization: Bearer {token}

响应示例

json
{
    "code": 200,
    "message": "缓存已刷新",
    "data": null
}

错误响应

401 未认证

json
{
    "code": 401,
    "message": "未认证",
    "data": null
}

403 无权限

json
{
    "code": 403,
    "message": "无权限访问",
    "data": null
}

基于 MIT 许可发布