Skip to content

平台配置 ​

两端品牌信息、用户端默认资料与系统版本号。

查询管理端公开配置(无需登录) ​

接口地址 ​

text
GET /admin/platform/public

接口说明 ​

登录页展示用,返回系统名称与 Logo 访问地址。

接口参数说明 ​

无请求参数。

响应示例 ​

json
{
  "code": 0,
  "msg": "success",
  "data": {
    "logo": "",
    "logo_path": "",
    "system_name": "",
    "version": "v0.0.3"
  }
}

响应参数说明 ​

响应字段类型说明
logostringLogo 访问地址
logo_pathstringLogo 相对路径
system_namestring系统名称
versionstring系统版本号,来自服务端 config.yaml,未配置时使用编译期内置版本

查询管理端平台配置 ​

接口地址 ​

text
GET /admin/platform/admin/detail

接口参数说明 ​

无请求参数。

响应示例 ​

json
{
  "code": 0,
  "msg": "success",
  "data": {
    "logo": "",
    "logo_path": "",
    "system_name": "",
    "version": "v0.0.3"
  }
}

响应参数说明 ​

响应字段类型说明
logostringLogo 访问地址
logo_pathstringLogo 相对路径
system_namestring系统名称
versionstring系统版本号,来自服务端 config.yaml,未配置时使用编译期内置版本

保存管理端平台配置 ​

接口地址 ​

text
POST /admin/platform/admin/save

接口说明 ​

按平台类型 upsert,重复保存不会产生多条记录。

接口参数说明 ​

Body 参数类型必填说明
logostring否Logo 相对路径(由上传接口返回的 relative_path)
system_namestring是系统名称,最长 100 字符

响应示例 ​

json
{
  "code": 0,
  "msg": "success",
  "data": {
    "logo": "",
    "logo_path": "",
    "system_name": "",
    "version": "v0.0.3"
  }
}

响应参数说明 ​

响应字段类型说明
logostringLogo 访问地址
logo_pathstringLogo 相对路径
system_namestring系统名称
versionstring系统版本号,来自服务端 config.yaml,未配置时使用编译期内置版本

查询用户端平台配置 ​

接口地址 ​

text
GET /admin/platform/user/detail

接口参数说明 ​

无请求参数。

响应示例 ​

json
{
  "code": 0,
  "msg": "success",
  "data": {
    "default_nickname": "",
    "default_avatar": "",
    "default_avatar_path": ""
  }
}

响应参数说明 ​

响应字段类型说明
default_nicknamestring用户端默认昵称
default_avatarstring默认头像访问地址
default_avatar_pathstring默认头像相对路径

保存用户端平台配置 ​

接口地址 ​

text
POST /admin/platform/user/save

接口参数说明 ​

Body 参数类型必填说明
default_nicknamestring是默认昵称,最长 100 字符
default_avatarstring否默认头像相对路径

响应示例 ​

json
{
  "code": 0,
  "msg": "success",
  "data": {
    "default_nickname": "",
    "default_avatar": "",
    "default_avatar_path": ""
  }
}

响应参数说明 ​

响应字段类型说明
default_nicknamestring用户端默认昵称
default_avatarstring默认头像访问地址
default_avatar_pathstring默认头像相对路径