接口参考平台设置与数据备份
保存平台名称和 Logo(system.manage)
PATCH /api/admin/v1/platform/branding,updatePlatformBranding 的请求参数和响应结构。
PATCH /api/admin/v1/platform/branding
| 项目 | 内容 |
|---|---|
| 操作标识 | updatePlatformBranding |
| 认证 | 登录会话 Cookie |
会话写请求需要合法的 Origin 和与当前 Cookie 绑定的 X-CSRF-Token。登录成功后应重新获取 CSRF 令牌。具体权限由目标资源归属和当前授权决定,见认证约定。
请求体
请求体必填。
内容类型:application/json。
| 字段 | 类型 | 必填 | 说明与约束 |
|---|---|---|---|
| platform_name | string | 是 | 最短 1;最长 64 |
| logo_base64 | string | 否 | 可选 PNG/JPG 图片的标准 Base64;最大 2 MiB,宽高最多 2048 像素;省略保留当前 Logo;格式:byte;最长 2796204 |
| reset_logo | boolean | 否 | 恢复内置 Logo,与 logo_base64 互斥;默认 false |
| copyright | string | 是 | 底部版权文字,空字符串显示平台名称;最长 256 |
| theme_color | string | 是 | 平台统一主题色;正则:^#[0-9A-Fa-f]{6}$ |
完整请求结构(含引用定义)
{
"$ref": "#/$defs/PlatformBrandingInput",
"$defs": {
"PlatformBrandingInput": {
"type": "object",
"additionalProperties": false,
"required": [
"platform_name",
"copyright",
"theme_color"
],
"properties": {
"platform_name": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"logo_base64": {
"type": "string",
"format": "byte",
"maxLength": 2796204,
"description": "可选 PNG/JPG 图片的标准 Base64;最大 2 MiB,宽高最多 2048 像素;省略保留当前 Logo"
},
"reset_logo": {
"type": "boolean",
"default": false,
"description": "恢复内置 Logo,与 logo_base64 互斥"
},
"copyright": {
"type": "string",
"maxLength": 256,
"description": "底部版权文字,空字符串显示平台名称"
},
"theme_color": {
"type": "string",
"pattern": "^#[0-9A-Fa-f]{6}$",
"description": "平台统一主题色"
}
}
}
}
}响应
| HTTP 状态 | 含义 |
|---|---|
| 200 | 成功 |
| 400 | 参数或图片无效 |
| 401 | 未登录 |
| 403 | 无 system.manage 权限、CSRF 或来源校验失败 |
| 503 | 平台设置数据库不可用 |
200 · application/json 响应结构
| 字段 | 类型 | 必填 | 说明与约束 |
|---|---|---|---|
| data | PlatformBranding | 是 | — |
| request_id | string | 是 | — |
{
"$ref": "#/$defs/PlatformBrandingResponse",
"$defs": {
"PlatformBrandingResponse": {
"type": "object",
"required": [
"data",
"request_id"
],
"properties": {
"data": {
"$ref": "#/$defs/PlatformBranding"
},
"request_id": {
"type": "string"
}
}
},
"PlatformBranding": {
"type": "object",
"additionalProperties": false,
"required": [
"platform_name",
"logo_url",
"copyright",
"theme_color"
],
"properties": {
"platform_name": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"logo_url": {
"type": "string",
"nullable": true,
"description": "同源 Logo 地址;null 使用内置 Logo"
},
"copyright": {
"type": "string",
"maxLength": 256,
"description": "底部版权文字,空字符串显示平台名称"
},
"theme_color": {
"type": "string",
"pattern": "^#[0-9A-Fa-f]{6}$",
"description": "平台统一主题色"
}
}
}
}
}400 / 401 / 403 / 503 · application/json 响应结构
{
"$ref": "#/$defs/ErrorResponse",
"$defs": {
"ErrorResponse": {
"type": "object",
"additionalProperties": false,
"properties": {
"error": {
"$ref": "#/$defs/ErrorDetail"
},
"request_id": {
"type": "string"
}
},
"required": [
"error",
"request_id"
]
},
"ErrorDetail": {
"type": "object",
"additionalProperties": false,
"properties": {
"code": {
"type": "string",
"enum": [
"NOT_IMPLEMENTED",
"NOT_FOUND",
"AUTH_REQUIRED",
"FORBIDDEN",
"VALIDATION_FAILED",
"CONFLICT",
"SERVICE_UNAVAILABLE",
"INTERNAL_ERROR",
"RATE_LIMITED"
]
},
"message": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"fields": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"required": [
"code",
"message",
"retryable"
]
}
}
}响应中的 request_id 用于排查请求;异步操作以任务最终状态为准。参阅调用约定、异步任务和错误处理。
本页由版本化 OpenAPI 契约生成。通用资源响应允许的任意字段以运行服务为准,不据此推断尚未定义的字段。
