Browse Source

feat: 文档更新

BaiLuoYan 1 day ago
parent
commit
1acb644ef6
1 changed files with 6 additions and 2 deletions
  1. 6 2
      README.md

+ 6 - 2
README.md

@@ -1344,17 +1344,21 @@ Content-Type: application/json
 
 #### POST /api/user/list — 用户列表
 
-分页查询用户列表,可选传入产品编码以附带成员身份信息。
+分页查询用户列表,支持按用户名、昵称、状态、部门筛选,可选传入产品编码以附带成员身份信息。
 
 **调用场景:**
 
-- **管理后台用户管理页面**:展示所有用户列表,含基本信息和状态
+- **管理后台用户管理页面**:展示所有用户列表,含基本信息和状态,支持多条件组合筛选
 - **按产品筛选成员视角**:传入 `productCode` 时,列表中每个用户会附带其在该产品中的 `memberType`(ADMIN/DEVELOPER/MEMBER/空),方便管理员了解哪些用户已经是该产品的成员
 - **添加成员时选择用户**:管理后台在添加产品成员时,先查询用户列表让管理员选择要添加的用户
 
 | 字段 | 类型 | 必填 | 说明 |
 | ------ | ------ | ------ | ------ |
 | productCode | string | 否 | 产品编码(传入则每个用户附带在该产品中的成员类型) |
+| username | string | 否 | 用户名(模糊匹配) |
+| nickname | string | 否 | 昵称(模糊匹配) |
+| status | int64 | 否 | 状态筛选(1=启用,2=禁用) |
+| deptId | *int64 | 否 | 部门 ID(0 表示无部门) |
 | page | int64 | 否 | 页码 |
 | pageSize | int64 | 否 | 每页条数 |