🇨🇳 简体中文
🇺🇸 English
🇯🇵 日本語
Skip to the content.

用户管理 API

模块: users

本模块包含 6 个API端点。

📋 端点列表


📖 详细说明

🔍 Get All Users

获取所有用户(仅管理员)

请求方式: GET /api/v1/users

响应:

// 数组: UserResponse[]
- `username` (string) - **必填** - 用户名
- `email` (string) - **必填** - 邮箱
- `phone` (object) - 可选 - 手机号
- `user_type` (object) - 可选 - 用户类型
  - 类型: `UserType`
- `status` (object) - 可选 - 用户状态
  - 类型: `UserStatus`
- `id` (string) - **必填** - 用户ID
- `created_at` (string) - **必填** - 创建时间
- `updated_at` (string) - **必填** - 更新时间

➕ Create User

创建用户(仅管理员)

请求方式: POST /api/v1/users

请求体:

// 参考模型: UserCreate
- `username` (string) - **必填** - 用户名
- `email` (string) - **必填** - 邮箱
- `phone` (object) - 可选 - 手机号
- `user_type` (object) - 可选 - 用户类型
  - 类型: `UserType`
- `status` (object) - 可选 - 用户状态
  - 类型: `UserStatus`
- `password` (string) - **必填** - 密码

响应:

// 参考模型: UserResponse
- `username` (string) - **必填** - 用户名
- `email` (string) - **必填** - 邮箱
- `phone` (object) - 可选 - 手机号
- `user_type` (object) - 可选 - 用户类型
  - 类型: `UserType`
- `status` (object) - 可选 - 用户状态
  - 类型: `UserStatus`
- `id` (string) - **必填** - 用户ID
- `created_at` (string) - **必填** - 创建时间
- `updated_at` (string) - **必填** - 更新时间

错误响应:


🔍 Get User

获取用户信息

请求方式: GET /api/v1/users/{user_id}

路径参数:

响应:

// 参考模型: UserResponse
- `username` (string) - **必填** - 用户名
- `email` (string) - **必填** - 邮箱
- `phone` (object) - 可选 - 手机号
- `user_type` (object) - 可选 - 用户类型
  - 类型: `UserType`
- `status` (object) - 可选 - 用户状态
  - 类型: `UserStatus`
- `id` (string) - **必填** - 用户ID
- `created_at` (string) - **必填** - 创建时间
- `updated_at` (string) - **必填** - 更新时间

错误响应:


✏️ Update User

更新用户信息

请求方式: PUT /api/v1/users/{user_id}

路径参数:

请求体:

// 参考模型: UserUpdate
- `username` (object) - 可选 - 
- `email` (object) - 可选 - 
- `phone` (object) - 可选 - 
- `user_type` (object) - 可选 - 
- `status` (object) - 可选 - 
- `password` (object) - 可选 - 密码(留空表示不修改)

响应:

// 参考模型: UserResponse
- `username` (string) - **必填** - 用户名
- `email` (string) - **必填** - 邮箱
- `phone` (object) - 可选 - 手机号
- `user_type` (object) - 可选 - 用户类型
  - 类型: `UserType`
- `status` (object) - 可选 - 用户状态
  - 类型: `UserStatus`
- `id` (string) - **必填** - 用户ID
- `created_at` (string) - **必填** - 创建时间
- `updated_at` (string) - **必填** - 更新时间

错误响应:


🗑️ Delete User

删除用户(仅管理员)

请求方式: DELETE /api/v1/users/{user_id}

路径参数:

响应:


错误响应:


🔍 Get User Accounts

获取用户账户信息

请求方式: GET /api/v1/users/{user_id}/accounts

路径参数:

响应:


错误响应: