接口列表.md · fastjrun/demo

# 快嘉

**简介**:快嘉

**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|
|&emsp;&emsp;name|用户名|string||
|&emsp;&emsp;roles||array|string|
|message|返回值消息|string||

**响应示例**:
```javascript
{
	"code": 0,
	"data": {
		"name": "",
		"roles": []
	},
	"message": ""
}
```

# 用户管理

## 新增用户

**接口地址**:`/system/user`

**请求方式**:`POST`

**请求数据类型**:`application/json`

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

**接口描述**:新增用户

**请求示例**:

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

**请求参数**:

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

**响应示例**:
```javascript
{
	"code": 0,
	"data": {},
	"message": ""
}
```

## 修改用户

**接口地址**:`/system/user`

**请求方式**:`PUT`

**请求数据类型**:`application/json`

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

**接口描述**:修改用户

**请求示例**:

**请求参数**:

**响应状态**:

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

**响应参数**:

**响应示例**:
```javascript
{
	"code": 0,
	"data": {},
	"message": ""
}
```

## 修改新密码

**接口地址**:`/system/user/password`

**请求方式**:`PUT`

**请求数据类型**:`application/json`

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

**接口描述**:修改新密码

**请求示例**:

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

**请求参数**:

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

**响应状态**:

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

**响应参数**:

**响应示例**:
```javascript
{
	"code": 0,
	"data": {},
	"message": ""
}
```

## 条件分页查询用户列表

**接口地址**:`/system/user/search`

**请求方式**:`POST`

**请求数据类型**:`application/json`

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

**接口描述**:条件分页查询用户列表

**请求示例**:

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

**请求参数**:

| 参数名称 | 参数说明 | 请求类型    | 是否必须 | 数据类型 | schema |
| -------- | -------- | ----- | -------- | -------- | ------ |
|requestBody|requestBody|body|true|UserQueryDTO|UserQueryDTO|
|&emsp;&emsp;current|当前页||false|integer(int32)||
|&emsp;&emsp;mobile|手机号||false|string||
|&emsp;&emsp;size|每页条数||false|integer(int32)||
|&emsp;&emsp;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|
|&emsp;&emsp;email|邮箱|string||
|&emsp;&emsp;id|用户Id|integer(int64)||
|&emsp;&emsp;isAccountNonExpired|帐号过期|integer(int32)||
|&emsp;&emsp;isAccountNonLocked|帐号锁定|integer(int32)||
|&emsp;&emsp;isCredentialsNonExpired|密码过期|integer(int32)||
|&emsp;&emsp;isEnabled|是否可用|integer(int32)||
|&emsp;&emsp;mobile|手机号|string||
|&emsp;&emsp;nickName|昵称|string||
|&emsp;&emsp;username|用户名|string||
|message|返回值消息|string||

**响应示例**:
```javascript
{
	"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|
|&emsp;&emsp;total|总数|integer(int64)||
|message|返回值消息|string||

**响应示例**:
```javascript
{
	"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||

**响应参数**:

## 删除用户信息

**接口地址**:`/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||

**响应参数**:

**响应示例**:
```javascript
{
	"code": 0,
	"data": {},
	"message": ""
}
```

fastjrun/demo

简介

发行版 (1)

贡献者

近期动态

fastjrun/demo .gitee-modal { width: 500px !important; }

简介

发行版 (1)

开源评估指数源自 OSS-Compass 评估体系，评估体系围绕以下三个维度对项目展开评估：

贡献者

近期动态

搜索帮助

fastjrun/demo