**API 文档：用户管理**

API 文档：用户管理

概述

本文档介绍用户管理 API 的使用方法，用于管理系统中的用户账户。

版本

1.0

日期

2023-10-26

作者

技术团队

目录

• 概述
• 版本
• 日期
• 作者
• 目录
• API 接口
  • 创建用户
  • 更新用户信息
  • 删除用户
  • 获取用户信息
  • 获取用户列表
• 请求参数
• 响应参数
• 错误码
• 示例

API 接口

1. 创建用户

请求方法: POST

请求地址: /users

请求参数:

| 参数名称 | 类型 | 描述 | 必填 | |---|---|---|---| | username | string | 用户名 | 是 | | email | string | 邮箱地址 | 是 | | password | string | 密码 | 是 | | role | string | 用户角色 | 否 |

响应参数:

| 参数名称 | 类型 | 描述 | |---|---|---| | status | string | 请求状态 | | data | object | 用户信息 |

示例:

请求:

json { "username": "testuser", "email": "[email protected]", "password": "password123", "role": "admin" }

响应:

json { "status": "success", "data": { "id": 1, "username": "testuser", "email": "[email protected]", "role": "admin" } }

2. 更新用户信息

请求方法: PUT

请求地址: /users/{userId}

请求参数:

| 参数名称 | 类型 | 描述 | 必填 | |---|---|---|---| | userId | integer | 用户ID | 是 | | username | string | 用户名 | 否 | | email | string | 邮箱地址 | 否 | | password | string | 密码 | 否 | | role | string | 用户角色 | 否 |

响应参数:

| 参数名称 | 类型 | 描述 | |---|---|---| | status | string | 请求状态 | | data | object | 更新后的用户信息 |

示例:

请求:

json { "username": "newtestuser", "email": "[email protected]" }

响应:

json { "status": "success", "data": { "id": 1, "username": "newtestuser", "email": "[email protected]", "role": "admin" } }

3. 删除用户

请求方法: DELETE

请求地址: /users/{userId}

请求参数:

| 参数名称 | 类型 | 描述 | 必填 | |---|---|---|---| | userId | integer | 用户ID | 是 |

响应参数:

| 参数名称 | 类型 | 描述 | |---|---|---| | status | string | 请求状态 |

示例:

请求:

DELETE /users/1

响应:

json { "status": "success" }

4. 获取用户信息

请求方法: GET

请求地址: /users/{userId}

请求参数:

| 参数名称 | 类型 | 描述 | 必填 | |---|---|---|---| | userId | integer | 用户ID | 是 |

响应参数:

| 参数名称 | 类型 | 描述 | |---|---|---| | status | string | 请求状态 | | data | object | 用户信息 |

示例:

请求:

GET /users/1

响应:

json { "status": "success", "data": { "id": 1, "username": "newtestuser", "email": "[email protected]", "role": "admin" } }

5. 获取用户列表

请求方法: GET

请求地址: /users

请求参数:

| 参数名称 | 类型 | 描述 | 必填 | |---|---|---|---| | page | integer | 页码 | 否 | | pageSize | integer | 每页数量 | 否 | | role | string | 用户角色 | 否 |

响应参数:

| 参数名称 | 类型 | 描述 | |---|---|---| | status | string | 请求状态 | | data | array | 用户列表 | | total | integer | 总记录数 |

示例:

请求:

GET /users?page=1&pageSize=10

响应:

json { "status": "success", "data": [ { "id": 1, "username": "newtestuser", "email": "[email protected]", "role": "admin" } ], "total": 1 }

请求参数

所有 API 接口均使用 JSON 格式进行请求和响应。

响应参数

所有 API 接口返回 JSON 格式的响应。

错误码

| 错误码 | 描述 | |---|---| | 400 | 错误的请求参数 | | 401 | 未授权 | | 403 | 禁止访问 | | 404 | 资源未找到 | | 500 | 服务器错误 |

示例

以上示例仅供参考，具体参数和响应格式可能根据实际情况有所调整。请参考接口文档中的具体说明。