用户API文档

用户API提供了一系列接口，方便开发者进行用户相关的操作。以下是对用户API的详细介绍。

功能概述

用户API主要包括用户信息查询、用户注册、用户登录、用户信息更新等功能。

接口列表

• 用户注册
• 用户登录
• 用户信息查询
• 用户信息更新

用户注册

用户注册接口允许开发者创建新的用户账号。

POST /user-api/register
Content-Type: application/json

请求参数：

• username: 用户名，必填
• password: 密码，必填
• email: 邮箱，必填

响应示例：

{
  "status": "success",
  "message": "注册成功",
  "data": {
    "userId": "123456"
  }
}

用户登录

用户登录接口允许开发者验证用户身份。

POST /user-api/login
Content-Type: application/json

请求参数：

• username: 用户名，必填
• password: 密码，必填

响应示例：

{
  "status": "success",
  "message": "登录成功",
  "data": {
    "token": "Bearer <token>"
  }
}

用户信息查询

用户信息查询接口允许开发者获取指定用户的信息。

GET /user-api/query?userId=<userId>

响应示例：

{
  "status": "success",
  "message": "查询成功",
  "data": {
    "userId": "123456",
    "username": "testUser",
    "email": "test@example.com"
  }
}

用户信息更新

用户信息更新接口允许开发者更新指定用户的信息。

PUT /user-api/update
Content-Type: application/json

请求参数：

• userId: 用户ID，必填
• username: 用户名，可选
• email: 邮箱，可选

响应示例：

{
  "status": "success",
  "message": "更新成功"
}

扩展阅读

更多关于用户API的详细信息，请参考我们的开发者文档。