187 lines
5.0 KiB
HTTP
187 lines
5.0 KiB
HTTP
### UserController 接口测试
|
||
### 在 IDEA 中选择 dev 或 prod 环境后执行
|
||
|
||
@userId =
|
||
@name = System
|
||
@password = u#HA027xq$i9]P}uB]LweJspTb!3oS^.
|
||
@newPassword = qwe123
|
||
@nick = 测试用户
|
||
@email = test@example.com
|
||
|
||
### 分页查询用户
|
||
### 权限:需要 ADMIN 角色 + USER_READ 权限
|
||
### 前置条件:需要先登录并回填 `user_token`
|
||
### 请求参数:Page<User>,详见 ./http/object/user.md
|
||
### 返回参数:PageResult<User>,详见 ./http/object/user.md
|
||
POST {{baseUrl}}/user/list
|
||
Content-Type: application/json
|
||
Token: {{user_token}}
|
||
|
||
{
|
||
"index": 0,
|
||
"size": 16
|
||
}
|
||
|
||
### 查询用户详情
|
||
### 权限:需要 ADMIN 角色 + USER_READ 权限
|
||
### 前置条件:需要先登录并回填 `user_token`,URL 参数 `id` 必须传有效用户 ID
|
||
### 请求参数:无请求体,URL 参数:`id` 为用户 ID
|
||
### 返回参数:User,详见 ./http/object/user.md
|
||
POST {{baseUrl}}/user/detail?id={{userId}}
|
||
Token: {{user_token}}
|
||
|
||
### 创建用户
|
||
### 权限:需要 ADMIN 角色 + USER_CREATE 权限
|
||
### 前置条件:需要先登录并回填 `user_token`,重复用户名通常会失败
|
||
### 请求参数:User,详见 ./http/object/user.md
|
||
### 返回参数:无
|
||
POST {{baseUrl}}/user/create
|
||
Content-Type: application/json
|
||
Token: {{user_token}}
|
||
|
||
{
|
||
"name": "{{name}}",
|
||
"nick": "{{nick}}",
|
||
"email": "{{email}}",
|
||
"phoneNo": "13800138000",
|
||
"password": "{{password}}"
|
||
}
|
||
|
||
### 更新用户
|
||
### 权限:需要 ADMIN 角色 + USER_UPDATE 权限
|
||
### 前置条件:需要先登录并回填 `user_token`,`id` 必须存在
|
||
### 请求参数:User,详见 ./http/object/user.md
|
||
### 返回参数:无
|
||
POST {{baseUrl}}/user/update
|
||
Content-Type: application/json
|
||
Token: {{user_token}}
|
||
|
||
{
|
||
"id": "{{userId}}",
|
||
"name": "{{name}}",
|
||
"nick": "{{nick}}",
|
||
"email": "{{email}}",
|
||
"phoneNo": "13800138000"
|
||
}
|
||
|
||
### 删除用户
|
||
### 权限:需要 ADMIN 角色
|
||
### 前置条件:需要先登录并回填 `user_token`,URL 参数 `id` 必须传有效用户 ID
|
||
### 请求参数:无请求体,URL 参数:`id` 为用户 ID
|
||
### 返回参数:无
|
||
POST {{baseUrl}}/user/delete?id={{userId}}
|
||
Token: {{user_token}}
|
||
|
||
### 注册
|
||
### 权限:无需登录
|
||
### 前置条件:重复用户名通常会失败
|
||
### 请求参数:User,详见 ./http/object/user.md
|
||
### 返回参数:LoginResponse,详见 ./http/object/user.md
|
||
POST {{baseUrl}}/user/register
|
||
Content-Type: application/json
|
||
|
||
{
|
||
"name": "Test",
|
||
"nick": "测试用户",
|
||
"phoneNo": "13800138000",
|
||
"password": "qwe123"
|
||
}
|
||
|
||
### 登录
|
||
### 权限:无需登录
|
||
### 前置条件:成功后需要把响应中的 token 回填到 `user_token`
|
||
### 请求参数:LoginRequest,详见 ./http/object/user.md
|
||
### 返回参数:LoginResponse,详见 ./http/object/user.md
|
||
POST {{baseUrl}}/user/login
|
||
Content-Type: application/json
|
||
|
||
{
|
||
"user": "{{name}}",
|
||
"password": "{{password}}"
|
||
}
|
||
|
||
> {%
|
||
client.global.set("user_token", response.body?.data?.token)
|
||
%}
|
||
|
||
### 令牌登录
|
||
### 权限:需要有效 Token
|
||
### 前置条件:需要先登录并回填 `user_token`
|
||
### 请求参数:无
|
||
### 返回参数:LoginResponse,详见 ./http/object/user.md
|
||
GET {{baseUrl}}/user/login/token
|
||
Token: {{user_token}}
|
||
|
||
### 登出
|
||
### 权限:当前控制器未声明 RequiredToken/权限注解,按服务端实际会话处理
|
||
### 前置条件:当前接口通常用于退出当前登录态
|
||
### 请求参数:无
|
||
### 返回参数:无
|
||
POST {{baseUrl}}/user/logout
|
||
Token: {{user_token}}
|
||
|
||
### 修改当前用户密码
|
||
### 权限:需要 USER_UPDATE 权限
|
||
### 前置条件:需要先登录并回填 `user_token`
|
||
### 请求参数:UpdatePasswordRequest,详见 ./http/object/user.md
|
||
### 返回参数:无
|
||
POST {{baseUrl}}/user/update/password
|
||
Content-Type: application/json
|
||
Token: {{user_token}}
|
||
|
||
{
|
||
"oldValue": "{{password}}",
|
||
"newValue": "{{newPassword}}"
|
||
}
|
||
|
||
### 修改当前用户邮箱
|
||
### 权限:需要 USER_UPDATE 权限
|
||
### 前置条件:当前方法体为空,接口尚未实现
|
||
### 请求参数:无
|
||
### 返回参数:无
|
||
POST {{baseUrl}}/user/update/email
|
||
Content-Type: application/json
|
||
Token: {{user_token}}
|
||
|
||
{}
|
||
|
||
### 发送当前用户手机号验证码
|
||
### 权限:需要 USER_UPDATE 权限
|
||
### 前置条件:需要先登录并回填 `user_token`
|
||
### 请求参数:PhoneVerifyCodeSendRequest,详见 ./http/object/user.md
|
||
### 返回参数:无
|
||
POST {{baseUrl}}/user/phone/verify/send
|
||
Content-Type: application/json
|
||
Token: {{user_token}}
|
||
|
||
{
|
||
"phoneNo": "13800138000"
|
||
}
|
||
|
||
### 验证当前用户手机号
|
||
### 权限:需要 USER_UPDATE 权限
|
||
### 前置条件:需要先调用手机号验证码发送接口获取验证码
|
||
### 请求参数:PhoneVerifyRequest,详见 ./http/object/user.md
|
||
### 返回参数:无
|
||
POST {{baseUrl}}/user/phone/verify
|
||
Content-Type: application/json
|
||
Token: {{user_token}}
|
||
|
||
{
|
||
"phoneNo": "13800138000",
|
||
"verifyCode": "123456"
|
||
}
|
||
|
||
### 注销当前用户
|
||
### 权限:需要 USER_DELETE 权限
|
||
### 前置条件:需要先登录并回填 `user_token`
|
||
### 请求参数:CancelRequest,详见 ./http/object/user.md
|
||
### 返回参数:无
|
||
POST {{baseUrl}}/user/cancel
|
||
Content-Type: application/json
|
||
Token: {{user_token}}
|
||
|
||
{
|
||
"password": "{{password}}"
|
||
}
|