跳到主要内容

check_username 用户名检查

POST /api/v1/users/check_username​

描述​

用户名检查接口，用于检查用户名是否存在, 如果存在则返回true表示没有重复的用户名，如果不存在则返回false表示有重复的用户名。返回false时候需要带上错误码和错误信息。

用于添加用户时候，检查用户名是否已经存在。

访问权限​

需要登录，具备以下权限：

users:check_username

JSON参数​

请求参数如下：

{
  "username": "require"
}

请求示例：

{
  "username": "huhulala"
}

响应结果​

请求返回的HTTP状态码为200 返回true表示没有重复的用户名，返回false表示有重复的用户名。

返回结果为JSON格式的数据，您可以通过解析JSON数据来获取API调用的结果信息。结构如下：

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

正确结果示例：

{
  "success": true
}

错误结果示例, 返回false时候需要带上错误码和错误信息：

{
  "success": false,
  "errorCode": "40008",
  "errorMessage": "username.already.exist",
  "showType": 9
}

错误码​

错误码说明错误信息显示类型
40008用户名已经存在username.already.exist1
40004用户名不合法error.invalid.username1
50000服务器错误server.error4
40006配置文件加载失败protocol.json.invalid1