62 Star 86 Fork 9

fastjrun / demo

加入 Gitee
与超过 600 万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
接口列表.md 10.72 KB
一键复制 编辑 Web IDE 原始数据 按行查看 历史
崔一凡 提交于 2021-09-14 10:34 . 删除修改密码功能

快嘉

简介:快嘉

HOST:localhost:8080

联系人:

Version:1.0

接口路径:/v2/api-docs

[TOC]

安全管理

获取用户信息

接口地址:/userinfo

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:application/json;charset=UTF-8

接口描述:

获取用户信息

请求参数:

暂无

响应状态:

状态码 说明 schema
200 OK 返回值结构«UserInfoVO»
401 Unauthorized
403 Forbidden
404 Not Found

响应参数:

参数名称 参数说明 类型 schema
code 返回值状态码(0000为成功) integer(int32) integer(int32)
data UserInfoVO UserInfoVO
  name 用户名 string
  roles array string
message 返回值消息 string

响应示例:

{
	"code": 0,
	"data": {
		"name": "",
		"roles": []
	},
	"message": ""
}

用户管理

新增用户

接口地址:/system/user

请求方式:POST

请求数据类型:application/json

响应数据类型:application/json;charset=UTF-8

接口描述:

新增用户

请求示例:

{
  "email": "",
  "id": 0,
  "isAccountNonExpired": 0,
  "isAccountNonLocked": 0,
  "isCredentialsNonExpired": 0,
  "isEnabled": 0,
  "mobile": "",
  "nickName": "",
  "username": ""
}

请求参数:

参数名称 参数说明 请求类型 是否必须 数据类型 schema
requestBody requestBody body true UserDTO UserDTO
  email 邮箱 true string
  id 用户Id true integer(int64)
  isAccountNonExpired 帐号过期 true integer(int32)
  isAccountNonLocked 帐号锁定 true integer(int32)
  isCredentialsNonExpired 密码过期 true integer(int32)
  isEnabled 是否可用 true integer(int32)
  mobile 手机号 true string
  nickName 昵称 true string
  username 用户名 true string

响应状态:

状态码 说明 schema
200 OK 返回值结构
201 Created
401 Unauthorized
403 Forbidden
404 Not Found

响应参数:

参数名称 参数说明 类型 schema
code 返回值状态码(0000为成功) integer(int32) integer(int32)
data object
message 返回值消息 string

响应示例:

{
	"code": 0,
	"data": {},
	"message": ""
}

修改用户

接口地址:/system/user

请求方式:PUT

请求数据类型:application/json

响应数据类型:application/json;charset=UTF-8

接口描述:

修改用户

请求示例:

{
  "email": "",
  "id": 0,
  "isAccountNonExpired": 0,
  "isAccountNonLocked": 0,
  "isCredentialsNonExpired": 0,
  "isEnabled": 0,
  "mobile": "",
  "nickName": "",
  "username": ""
}

请求参数:

参数名称 参数说明 请求类型 是否必须 数据类型 schema
requestBody requestBody body true UserDTO UserDTO
  email 邮箱 true string
  id 用户Id true integer(int64)
  isAccountNonExpired 帐号过期 true integer(int32)
  isAccountNonLocked 帐号锁定 true integer(int32)
  isCredentialsNonExpired 密码过期 true integer(int32)
  isEnabled 是否可用 true integer(int32)
  mobile 手机号 true string
  nickName 昵称 true string
  username 用户名 true string

响应状态:

状态码 说明 schema
200 OK 返回值结构
201 Created
401 Unauthorized
403 Forbidden
404 Not Found

响应参数:

参数名称 参数说明 类型 schema
code 返回值状态码(0000为成功) integer(int32) integer(int32)
data object
message 返回值消息 string

响应示例:

{
	"code": 0,
	"data": {},
	"message": ""
}

修改新密码

接口地址:/system/user/password

请求方式:PUT

请求数据类型:application/json

响应数据类型:application/json;charset=UTF-8

接口描述:

修改新密码

请求示例:

{
  "newPassword": "",
  "repPassword": "",
  "userId": 0
}

请求参数:

参数名称 参数说明 请求类型 是否必须 数据类型 schema
requestBody requestBody body true 修改用户新密码请求对象 修改用户新密码请求对象
  newPassword 新密码 false string
  repPassword 确认密码 false string
  userId 用户Id true integer(int64)

响应状态:

状态码 说明 schema
200 OK 返回值结构
201 Created
401 Unauthorized
403 Forbidden
404 Not Found

响应参数:

参数名称 参数说明 类型 schema
code 返回值状态码(0000为成功) integer(int32) integer(int32)
data object
message 返回值消息 string

响应示例:

{
	"code": 0,
	"data": {},
	"message": ""
}

条件分页查询用户列表

接口地址:/system/user/search

请求方式:POST

请求数据类型:application/json

响应数据类型:application/json;charset=UTF-8

接口描述:

条件分页查询用户列表

请求示例:

{
  "current": 0,
  "mobile": "",
  "size": 0,
  "username": ""
}

请求参数:

参数名称 参数说明 请求类型 是否必须 数据类型 schema
requestBody requestBody body true UserQueryDTO UserQueryDTO
  current 当前页 false integer(int32)
  mobile 手机号 false string
  size 每页条数 false integer(int32)
  username 用户名 false string

响应状态:

状态码 说明 schema
200 OK 返回值结构«UserVO»
201 Created
401 Unauthorized
403 Forbidden
404 Not Found

响应参数:

参数名称 参数说明 类型 schema
code 返回值状态码(0000为成功) integer(int32) integer(int32)
data UserVO UserVO
  email 邮箱 string
  id 用户Id integer(int64)
  isAccountNonExpired 帐号过期 integer(int32)
  isAccountNonLocked 帐号锁定 integer(int32)
  isCredentialsNonExpired 密码过期 integer(int32)
  isEnabled 是否可用 integer(int32)
  mobile 手机号 string
  nickName 昵称 string
  username 用户名 string
message 返回值消息 string

响应示例:

{
	"code": 0,
	"data": {
		"email": "",
		"id": 0,
		"isAccountNonExpired": 0,
		"isAccountNonLocked": 0,
		"isCredentialsNonExpired": 0,
		"isEnabled": 0,
		"mobile": "",
		"nickName": "",
		"username": ""
	},
	"message": ""
}

统计用户总数

接口地址:/system/user/statistic/total

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:application/json;charset=UTF-8

接口描述:

统计用户总数

请求参数:

暂无

响应状态:

状态码 说明 schema
200 OK 返回值结构«TotalVO»
401 Unauthorized
403 Forbidden
404 Not Found

响应参数:

参数名称 参数说明 类型 schema
code 返回值状态码(0000为成功) integer(int32) integer(int32)
data TotalVO TotalVO
  total 总数 integer(int64)
message 返回值消息 string

响应示例:

{
	"code": 0,
	"data": {
		"total": 0
	},
	"message": ""
}

查询用户信息

接口地址:/system/user/{id}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:application/json;charset=UTF-8

接口描述:

查询用户信息

请求参数:

参数名称 参数说明 请求类型 是否必须 数据类型 schema
id 用户ID path true integer(int64)

响应状态:

状态码 说明 schema
200 OK 返回值结构«UserVO»
401 Unauthorized
403 Forbidden
404 Not Found

响应参数:

参数名称 参数说明 类型 schema
code 返回值状态码(0000为成功) integer(int32) integer(int32)
data UserVO UserVO
  email 邮箱 string
  id 用户Id integer(int64)
  isAccountNonExpired 帐号过期 integer(int32)
  isAccountNonLocked 帐号锁定 integer(int32)
  isCredentialsNonExpired 密码过期 integer(int32)
  isEnabled 是否可用 integer(int32)
  mobile 手机号 string
  nickName 昵称 string
  username 用户名 string
message 返回值消息 string

响应示例:

{
	"code": 0,
	"data": {
		"email": "",
		"id": 0,
		"isAccountNonExpired": 0,
		"isAccountNonLocked": 0,
		"isCredentialsNonExpired": 0,
		"isEnabled": 0,
		"mobile": "",
		"nickName": "",
		"username": ""
	},
	"message": ""
}

删除用户信息

接口地址:/system/user/{id}

请求方式:DELETE

请求数据类型:application/x-www-form-urlencoded

响应数据类型:application/json;charset=UTF-8

接口描述:

删除用户信息

请求参数:

参数名称 参数说明 请求类型 是否必须 数据类型 schema
id 用户ID path true integer(int64)

响应状态:

状态码 说明 schema
200 OK 返回值结构
204 No Content
401 Unauthorized
403 Forbidden

响应参数:

参数名称 参数说明 类型 schema
code 返回值状态码(0000为成功) integer(int32) integer(int32)
data object
message 返回值消息 string

响应示例:

{
	"code": 0,
	"data": {},
	"message": ""
}

评论 ( 0 )

你可以在登录后,发表评论

Java
1
https://gitee.com/fastjrun/demo.git
git@gitee.com:fastjrun/demo.git
fastjrun
demo
demo
master

搜索帮助