用户管理接口文档模板示例

2018-01-17

用户管理

接口概述

概述:

所属模块 所属构件包 Controller类 Url路径
系统管理 com.nbcb.crm.galaxy com.nbcb.galaxy.controller.UserController com.nbcb.galsxy.user

接口清单

接口名称 说明 编号
queryUserPage 获取用户列表 1
addUser 添加用户 2
queryUserByOrg 根据机构查询用户 3
updateUser 更新用户 4
selectHisPage 编辑历史查询 5
lockUsers 锁定用户 6
unlockUsers 解锁用户 7
resetPwd 密码重置 8
delUser 删除用户 9
recoveryUser 恢复用户 10

分层及对象模型定义

逻辑分层

  • 控制层controller ↓
  • 服务层service
  • Dao层
  • model层

Model或参数对象定义

  • Page 分页信息

字段id 类型 中文说明
pageIndex int 页索引号(从0开始)
pageSize int 页大小
  • GFUser 用户信息

字段id 类型 中文说明
pageIndex int 页索引号(从0开始)
pageSize int 页大小
pageIndex int 页索引号(从0开始)
pageSize int 页大小
pageIndex int 页索引号(从0开始)
pageSize int 页大小
pageIndex int 页索引号(从0开始)
pageSize int 页大小
pageIndex int 页索引号(从0开始)
pageSize int 页大小
pageIndex int 页索引号(从0开始)
pageSize int 页大小
pageIndex int 页索引号(从0开始)
pageSize int 页大小
pageIndex int 页索引号(从0开始)
pageSize int 页大小
pageIndex int 页索引号(从0开始)
pageSize int 页大小
pageIndex int 页索引号(从0开始)
pageSize int 页大小
pageIndex int 页索引号(从0开始)
pageSize int 页大小
pageIndex int 页索引号(从0开始)
pageSize int 页大小
pageIndex int 页索引号(从0开始)
pageSize int 页大小
pageIndex int 页索引号(从0开始)
pageSize int 页大小
  • GFUserExplnfo 用户信息拓展信息(继承GFUser)

字段id 类型 中文说明
pageIndex int 页索引号(从0开始)
pageSize int 页大小
pageIndex int 页索引号(从0开始)
pageSize int 页大小
pageIndex int 页索引号(从0开始)
pageSize int 页大小
pageIndex int 页索引号(从0开始)
pageSize int 页大小
pageIndex int 页索引号(从0开始)
pageSize int 页大小
pageIndex int 页索引号(从0开始)
pageSize int 页大小
pageIndex int 页索引号(从0开始)
pageSize int 页大小
  • GFPosition 职位信息

字段id 类型 中文说明
pageIndex int 页索引号(从0开始)
pageSize int 页大小
pageIndex int 页索引号(从0开始)
pageSize int 页大小
pageIndex int 页索引号(从0开始)
pageSize int 页大小
pageIndex int 页索引号(从0开始)
pageSize int 页大小
pageIndex int 页索引号(从0开始)
pageSize int 页大小
pageIndex int 页索引号(从0开始)
pageSize int 页大小
pageIndex int 页索引号(从0开始)
pageSize int 页大小

接口详细设计

  • 查询用户 queryUserPage

输入参数:

字段id 类型 中文说明 是否必填 来源
q GFUserExplnfo 查询参数 前端输入
password string 密码
password string 密码
q GFUserExplnfo 查询参数 前端输入
password string 密码
password string 密码
q GFUserExplnfo 查询参数 前端输入
password string 密码
password string 密码
q GFUserExplnfo 查询参数 前端输入
password string 密码
password string 密码

输出参数:

字段id 类型 中文说明
data PageData 用户列表

查询逻辑:

- 查询用户
  • 新增 addUser

输入参数:

字段id 类型 中文说明 是否必填 来源
user GFUser 用户 前端输入

输出参数:

字段id 类型 中文说明
status boolean 状态

处理逻辑:

- 判断用户工号是否存在
- 添加用户
- 增加用户更新历史
- 增加职位信息
  • 根据机构查询用户 queryUserByOrg

输入参数:

字段id 类型 中文说明 是否必填 来源
user GFUser 用户 前端输入

输出参数:

字段id 类型 中文说明
status boolean 状态

处理逻辑:

  • 编辑用户 updateUser

输入参数:

字段id 类型 中文说明 是否必填 来源
user GFUser 用户 前端输入

输出参数:

字段id 类型 中文说明
status boolean 状态

处理逻辑:

  • 查询用户更新记录 selectHisPage

输入参数:

字段id 类型 中文说明 是否必填 来源
user GFUser 用户 前端输入

输出参数:

字段id 类型 中文说明
status boolean 状态

处理逻辑:

  • 锁定用户 lockUsers

输入参数:

字段id 类型 中文说明 是否必填 来源
user GFUser 用户 前端输入

输出参数:

字段id 类型 中文说明
status boolean 状态

处理逻辑:

  • 解锁用户 unlockUsers

输入参数:

字段id 类型 中文说明 是否必填 来源
user GFUser 用户 前端输入

输出参数:

字段id 类型 中文说明
status boolean 状态

处理逻辑:

  • 删除用户 delUser

输入参数:

字段id 类型 中文说明 是否必填 来源
user GFUser 用户 前端输入

输出参数:

字段id 类型 中文说明
status boolean 状态

处理逻辑:

- 逻辑删除用户,更新变更记录
- HR同步的不能删除
  • 恢复用户 recoveryUser

输入参数:

字段id 类型 中文说明 是否必填 来源
user GFUser 用户 前端输入

输出参数:

字段id 类型 中文说明
status boolean 状态

处理逻辑:

- 逻辑删除用户,更新变更记录
  • 密码重置 resetPwd

输入参数:

字段id 类型 中文说明 是否必填 来源
user GFUser 用户 前端输入

输出参数:

字段id 类型 中文说明
status boolean 状态

处理逻辑:

- 循环重置用户密码,更新变更记录