API-DOC/api/Auth-权限.md

Auth - 权限

url 前缀：auth

示例：https://xxxxxxxxx/api/auth/xxxx

获得当前登录用户的信息

get /current

Response

interface UserData {
  err: 0 | 401 /* 用户信息失效 */;
  res: UserSerializer;
}

see UserSerializer

更新当前登录用户的手机号信息

put /current/phone

Parameters

interface UpdatePhoneDTO {
  phone: string;
  token: string; // 验证码
}

Response

interface UserData {
  err: 0;
  res: UserSerializer;
}

更新当前用户的信息

put /current

Parameters

interface UpdateEmailDTO {
  name: string;
  email: string;
}

Response

interface UserData {
  err: 0;
  res: UserSerializer;
}

see UserSerializer

登录

post /login

Parameters

interface loginDTO {
  username: string;
  password: string;
}

Response

interface UserData {
  err: 0 | 403 /* 用户名密码错 */;
  res: UserSerializer;
}

see UserSerializer

手机验证码

post /verification

Parameters

interface VerficationDTO {
  phoneNumber: string;
}

修改密码

STUDENT TEACHER

post /password/change

Parameters

interface ChangePasswordForm {
  origin: string;
  password: string;
  confirm: string;
}

Response

interface EmptyData {
  err: 0;
}

注册

post /register

Parameters

interface RegisterDTO {
  name: string; // 用户真实姓名
  username: string;
  password: string;
  phoneNumber: string;
  token: string;
  email: string;
}

Response

interface UserData {
  err: 0 | 400;
  res: UserSerializer;
}

see UserSerializer

修改密码

STUDENT TEACHER

post /password/change

Parameters

interface ChangePasswordForm {
  origin: string;
  password: string;
  confirm: string;
}

Response

interface EmptyData {
  err: 0;
}

找回密码

STUDENT TEACHER

post /password/new

Parameters

interface FindPasswordForm {
  phoneNumber: string;
  token: string;
  newPassword: string;
}

Response

interface EmptyData {
  err: 0;
}