跳到主要内容

login 登录

POST /api/v1/auth/login​

描述​

用户登录接口，用于用户登录系统

JSON参数​

请求参数如下：

{
  "username": string,
  "password": string
}
提示
  • username: 用户名
  • password: 密码

请求示例：

{
  "username": "huhulala",
  "password": "jiushipassword"
}

响应结果​

请求返回的HTTP状态码为200

{
  "success": true|false,
  "data"?: {
    "username": string,
    "token": "jwt token" 
  },
  "errorCode"?: "option string",
  "errorMessage"?: "option string",
  "showType"?: 0|1|2|4|9,
  "traceId"?: "option string"
}

说明：

  • token: 登录成功后返回的jwt token，用于后续请求的身份验证
  • errorCode: 错误码，可选，用于前端展示错误信息 2xxxxx 表示业务错误，4xxxxx 表示客户端照成的错误，5xxxxx 表示服务端错误
  • errorMessage: 错误信息，可选，用于前端展示错误信息，使用点分隔的英文信息，在前端进行国际化
  • showType: 错误展示类型，可选，用于前端展示错误信息 0: 不展示 1: 通知 2: 警告 4: 错误 9: 在页面内部展示的错误，如表单验证错误
  • traceId: 用于追踪错误信息的id，可选，一般用于服务端错误的追踪

正确响应结构示例：

{
  "success": true,
  "data": {
    "username": "huhulala",
    "token": "jwt token"
  }
}

错误响应结构示例：

{
  "success": false,
  "errorCode": "40001",
  "errorMessage": "username.or.password.error",
  "showType": 4
}

错误码​

错误码说明错误信息显示类型
40001用户名或密码错误username.or.password.error1
40007用户文件不存在user.file.not.exist1
50000服务器错误server.error2
40006配置文件加载失败protocol.json.invalid1
40007用户已被删除user.deleted1
40007密码错误password.error1