概述
本开发文档详细描述了MIS系统中的修改用户状态接口的设计与实现。通过该接口,管理员可以根据用户ID修改用户的状态。
功能需求
- 修改用户状态:管理员可以通过提交用户ID和新的状态码来修改用户的状态。
- 权限控制:确保只有具有特定权限的用户可以访问此接口并修改用户状态。
接口详情
修改用户状态接口
接口路径
/mis_user/changeStatusById
请求方法
POST
接口描述
该接口用于修改用户的状态。管理员提交用户ID和新的状态码后,系统会更新数据库中的用户状态信息。
POST 修改用户状态
POST /user/changeStatusById
Body 请求参数
{
"id": 5,
"status": 0
}
请求参数
名称 | 位置 | 类型 | 必选 | 说明 |
---|---|---|---|---|
Token | header | string | 否 | none |
body | body | object | 否 | none |
» id | body | integer | 是 | none |
» status | body | integer | 是 | none |
返回示例
成功
{
"msg": "success",
"code": 200
}
返回结果
状态码 | 状态码含义 | 说明 | 数据模型 |
---|---|---|---|
200 | OK | 成功 | Inline |
返回数据结构
状态码 200
名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
---|---|---|---|---|---|
» msg | string | true | none | none | |
» code | integer | true | none | none |
实现细节
控制器代码
@PostMapping("/changeStatusById")
@SaCheckLogin
@SaCheckPermission(value = {"ROOT", "USER:UPDATE"}, mode = SaMode.OR)
public R changeStatusById(@RequestBody @Valid ChangeStatusByIdForm form){
Map param = BeanUtil.beanToMap(form);
boolean flag = userService.changeStatusById(param);
if (flag){
return R.ok();
}else {
return R.error("未能修改用户状态,请联系管理员");
}
}
表单验证类
@Data
public class ChangeStatusByIdForm {
private Integer id;
@NotNull(message = "status状态码不能为空")
@Range(min = 0, max = 1, message = "status状态码不正确,0无效(逻辑删除),1有效")
private Byte status;
}
XML
<!-- 修改用户状态-->
<update id="changeStatusById" parameterType="Map" >
UPDATE user
SET status = #{status}
WHERE id = #{id}
</update>
</mapper>