Skip to content

配置相关接口

获取邮箱配置

请求URL

  • /api/v1/config/getEmailConfig

请求方式

  • GET

请求头

  • Authorization': token

返回示例

json
{
  "code": 200,
  "data": {
    "config": {
      "user": "",
      "host": "",
      "port": 465,
      "addresser": "",
    },
  },
  "msg": "ok"
}

返回参数说明

参数名类型说明
userstring邮箱发送者
hoststringSMTP服务器地址
portintSMTP服务器端口
addresserstring发送者的邮箱

备注

修改邮箱配置

请求URL

  • /api/v1/config/setEmailConfig

请求方式

  • POST

请求头

  • Authorization': token
  • "content-type": "application/json"

参数

参数名必选类型说明
userstring邮箱发送者
hoststringSMTP服务器地址
portintSMTP服务器端口
addresserstring发送者的邮箱
passstring邮箱秘钥

返回示例

json
{
  "code": 200,
  "data": null,
  "msg":"ok"
}

备注

获取存储配置

请求URL

  • /api/v1/config/getStorageConfig

请求方式

  • GET

请求头

  • Authorization': token

返回示例

json
{
  "code": 200,
  "data": {
    "config": {
      "maxImgSize": 5,
      "maxVideoSize": 500,
      "type": "",
      "keyId": "",
      "bucket": "",
      "endpoint": "",
      "domain": "",
      "uploadMp4File": false,
    },
  },
  "msg": "ok"
}

返回参数说明

参数名类型说明
maxImgSizeint上传图片的大小限制
maxVideoSizeint上传视频的大小限制
typestring对象存储类型,目前仅支持本地(local)和阿里云OSS(aliyun)
keyIdstring对应阿里云access_key_secret
bucketstring对象存储的bucket
endpointstring阿里云OSS的endpoint
domainstring自定义域名
uploadMp4Filebool上传对象存储时是否上传原始mp4文件

备注

修改存储配置

请求URL

  • /api/v1/config/setStorageConfig

请求方式

  • POST

请求头

  • Authorization': token
  • "content-type": "application/json"

参数

参数名必选类型说明
maxImgSizeint上传图片的大小限制
maxVideoSizeint上传视频的大小限制
typestring对象存储类型,目前仅支持本地(local)和阿里云OSS(aliyun)
keyIdstring对应阿里云access_key_secret
bucketstring对象存储的bucket
endpointstring阿里云OSS的endpoint
domainstring自定义域名
uploadMp4Filebool上传对象存储时是否上传原始mp4文件

返回示例

json
{
  "code": 200,
  "data": null,
  "msg":"ok"
}

备注

获取其他配置

请求URL

  • /api/v1/config/getOtherConfig

请求方式

  • GET

请求头

  • Authorization': token

返回示例

json
{
  "code": 200,
  "data": {
    "config": {
      "allowOrigin": "",
      "prefix": "",
    },
  },
  "msg": "ok"
}

返回参数说明

参数名类型说明
allowOriginstring跨域配置,存在多个使用,分隔
prefixstring用户注册时生成用户名的默认前缀

备注

修改其他配置

请求URL

  • /api/v1/config/setOtherConfig

请求方式

  • POST

请求头

  • Authorization': token
  • "content-type": "application/json"

参数

参数名必选类型说明
allowOriginstring跨域配置,存在多个使用,分隔
prefixstring用户注册时生成用户名的默认前缀

返回示例

json
{
  "code": 200,
  "data": null,
  "msg":"ok"
}

备注

根据 MIT 许可证发布