Skip to content
本页目录

用户接口

此文档为憧门新番站点的用户接口文档说明!

用户登录

请求路由

/ako/user/login

请求方法

POST

请求头参数
请求参数请求内容是否必传参数类型参数说明
Content-Typemultipart/form-dataString参数格式
请求体参数
请求参数是否必传参数类型参数说明
usernameString用户名
passwordString密码
响应示例
JSON
{
  "id": "64a55fb1851x077f4c538a8c",  // 用户 id
  "username": "ANi",  // 用户名
  "email": "ani@muri.life",  // 邮箱
  "puber": true,  // 是否拥有发布字幕权限
  "avatar": "/avatar/default.jpg",  // 头像
  "subAni": 0,  // 订阅番剧数
  "subSub": 0,  // 订阅字幕组数
  "token": "eyJhbGciOiJIUzI1NiIsInR5cIkpXVCJ9.eyJ1c2VySW5mbyI6eyJfaWQiOiI2NGE1NWZiMTGM1MzhhOGMiLCJ1c2VybmFtZSI6IkFOaSIsImVtYWlsIjoiYW5pQG11cm3ViQW5pIjowLCJzdWJTdWIiOjAsImNyZWF0ZUF0IjoiMjAyMy0wNy0wNVQwNTo0MzowNS4yMjVaIiwiX192IjowfSwiaW2MzMyNjI4LCJleHAiOjE3MDY5Mzc0Mjh9.x9pCV_ndlRXNA9fAezWxJnHoXMy8Y36VU_dpl7b3mnU"
}

用户注册

请求路由

/ako/user/register

请求方法

POST

请求头参数
请求参数请求内容是否必传参数类型参数说明
Content-Typemultipart/form-dataString参数格式
请求体参数
请求参数是否必传参数类型参数说明
usernameString用户名
passwordString密码
emailString邮箱
puberBoolean字幕上传权限
响应示例
JSON
{
  "msg": "注册成功"
}

用户注销

请求路由

/ako/user/cancel

请求方法

DELETE

请求头参数
请求参数请求内容是否必传参数类型参数说明
AuthorizationBearer ${token}String身份验证 token
请求体参数

响应示例
JSON
{
  "msg": "注销成功"
}

用户身份验证

请求路由

/ako/user/verify

请求方法

GET

请求头参数
请求参数请求内容是否必传参数类型参数说明
AuthorizationBearer ${token}String身份验证 token
请求体参数

响应示例
JSON
{
  "msg": "ok"
}

用户上传头像

请求路由

/ako/user/avatar

请求方法

POST

请求头参数
请求参数请求内容是否必传参数类型参数说明
AuthorizationBearer ${token}String身份验证 token
Content-Typemultipart/form-dataString参数格式
请求体参数
请求参数是否必传参数类型参数说明
avatarFile头像文件
响应示例
JSON
{
  "msg": "头像上传成功"
}

用户邮箱验证

请求路由

/ako/user/email

请求方法

POST

请求头参数
请求参数请求内容是否必传参数类型参数说明
Content-Typemultipart/form-dataString参数格式
请求体参数
请求参数是否必传参数类型参数说明
emailString接收验证码的邮箱
响应示例

该接口调用后,会向邮箱发送验证码。

JSON
{
  "msg": "MgAwADcAMgA5ADMA"  // 验证码(需手动转码)
}

用户重置密码

此重置密码接口为:通过验证有效邮箱后,通过邮箱重置密码(非登录状态)。

请求路由

/ako/user/reset

请求方法

POST

请求头参数
请求参数请求内容是否必传参数类型参数说明
Content-Typemultipart/form-dataString参数格式
请求体参数
请求参数是否必传参数类型参数说明
emailString账户绑定的邮箱
passwordString新密码
响应示例
JSON
{
  "msg": "密码修改成功"
}

用户修改密码

此修改密码接口为:登录状态下修改密码。

请求路由

/ako/user/update

请求方法

PUT

请求头参数
请求参数请求内容是否必传参数类型参数说明
AuthorizationBearer ${token}String身份验证 token
Content-Typemultipart/form-dataString参数格式
请求体参数
请求参数是否必传参数类型参数说明
emailString新邮箱
passwordString新密码
响应示例
JSON
{
  "msg": "密码修改成功"
}

用户修改邮箱

此修改邮箱接口为:登录状态下修改邮箱。

用户修改密码

响应示例
JSON
{
  "msg": "邮箱修改成功"
}