代码拉取完成,页面将自动刷新
API接口文档
简介:
springboot集成websocket,实现即时通讯
HOST:localhost:39112
联系人:huahua1013
Version:1.0
接口路径:/v2/api-docs
接口描述:
接口地址:/user/login
请求方式:POST
consumes:["application/json"]
produces:["*/*"]
请求示例:
{
"accountNonExpired": true,
"accountNonLocked": true,
"authorities": [
{
"authority": ""
}
],
"createTime": "",
"credentialsNonExpired": true,
"enabled": true,
"id": "",
"modifyTime": "",
"nickName": "",
"password": "",
"phoneNumber": "",
"state": "",
"token": "",
"userName": "",
"userPassword": "",
"username": ""
}
请求参数:
参数名称 | 参数说明 | in | 是否必须 | 数据类型 | schema |
---|---|---|---|---|---|
user | user | body | true | 用户实体类 | 用户实体类 |
schema属性说明
用户实体类
参数名称 | 参数说明 | in | 是否必须 | 数据类型 | schema |
---|---|---|---|---|---|
accountNonExpired | body | false | boolean | ||
accountNonLocked | body | false | boolean | ||
authorities | body | false | array | GrantedAuthority | |
createTime | 创建时间 | body | false | string(date-time) | |
credentialsNonExpired | body | false | boolean | ||
enabled | body | false | boolean | ||
id | id | body | false | string | |
modifyTime | 修改时间 | body | false | string(date-time) | |
nickName | 昵称 | body | false | string | |
password | body | false | string | ||
phoneNumber | 电话号码,用来登陆和判断唯一标识 | body | false | string | |
state | 状态 1:有效 2:无效 | body | false | string | |
token | jwt生成token | body | false | string | |
userName | body | false | string | ||
userPassword | 密码 | body | false | string | |
username | body | false | string |
GrantedAuthority
参数名称 | 参数说明 | in | 是否必须 | 数据类型 | schema |
---|---|---|---|---|---|
authority | body | false | string |
响应示例:
{
"code": 0,
"data": {
"accountNonExpired": true,
"accountNonLocked": true,
"authorities": [
{
"authority": ""
}
],
"createTime": "",
"credentialsNonExpired": true,
"enabled": true,
"id": "",
"modifyTime": "",
"nickName": "",
"password": "",
"phoneNumber": "",
"state": "",
"token": "",
"userName": "",
"userPassword": "",
"username": ""
},
"msg": ""
}
响应参数:
参数名称 | 参数说明 | 类型 | schema |
---|---|---|---|
code | integer(int32) | integer(int32) | |
data | 用户实体类 | 用户实体类 | |
msg | string |
schema属性说明
用户实体类
参数名称 | 参数说明 | 类型 | schema |
---|---|---|---|
accountNonExpired | boolean | ||
accountNonLocked | boolean | ||
authorities | array | GrantedAuthority | |
createTime | 创建时间 | string(date-time) | |
credentialsNonExpired | boolean | ||
enabled | boolean | ||
id | id | string | |
modifyTime | 修改时间 | string(date-time) | |
nickName | 昵称 | string | |
password | string | ||
phoneNumber | 电话号码,用来登陆和判断唯一标识 | string | |
state | 状态 1:有效 2:无效 | string | |
token | jwt生成token | string | |
userName | string | ||
userPassword | 密码 | string | |
username | string |
GrantedAuthority
参数名称 | 参数说明 | 类型 | schema |
---|---|---|---|
authority | string |
响应状态:
状态码 | 说明 | schema |
---|---|---|
200 | OK | ResponseResult«用户实体类» |
201 | Created | |
401 | Unauthorized | |
403 | Forbidden | |
404 | Not Found |
接口描述:
接口地址:/user/register
请求方式:POST
consumes:["application/json"]
produces:["*/*"]
请求示例:
{
"accountNonExpired": true,
"accountNonLocked": true,
"authorities": [
{
"authority": ""
}
],
"createTime": "",
"credentialsNonExpired": true,
"enabled": true,
"id": "",
"modifyTime": "",
"nickName": "",
"password": "",
"phoneNumber": "",
"state": "",
"token": "",
"userName": "",
"userPassword": "",
"username": ""
}
请求参数:
参数名称 | 参数说明 | in | 是否必须 | 数据类型 | schema |
---|---|---|---|---|---|
user | user | body | true | 用户实体类 | 用户实体类 |
schema属性说明
用户实体类
参数名称 | 参数说明 | in | 是否必须 | 数据类型 | schema |
---|---|---|---|---|---|
accountNonExpired | body | false | boolean | ||
accountNonLocked | body | false | boolean | ||
authorities | body | false | array | GrantedAuthority | |
createTime | 创建时间 | body | false | string(date-time) | |
credentialsNonExpired | body | false | boolean | ||
enabled | body | false | boolean | ||
id | id | body | false | string | |
modifyTime | 修改时间 | body | false | string(date-time) | |
nickName | 昵称 | body | false | string | |
password | body | false | string | ||
phoneNumber | 电话号码,用来登陆和判断唯一标识 | body | false | string | |
state | 状态 1:有效 2:无效 | body | false | string | |
token | jwt生成token | body | false | string | |
userName | body | false | string | ||
userPassword | 密码 | body | false | string | |
username | body | false | string |
GrantedAuthority
参数名称 | 参数说明 | in | 是否必须 | 数据类型 | schema |
---|---|---|---|---|---|
authority | body | false | string |
响应示例:
{
"code": 0,
"data": {},
"msg": ""
}
响应参数:
参数名称 | 参数说明 | 类型 | schema |
---|---|---|---|
code | integer(int32) | integer(int32) | |
data | object | ||
msg | string |
响应状态:
状态码 | 说明 | schema |
---|---|---|
200 | OK | ResponseResult |
201 | Created | |
401 | Unauthorized | |
403 | Forbidden | |
404 | Not Found |
接口描述:
接口地址:/sendMsgToOther
请求方式:POST
consumes:["application/json"]
produces:["*/*"]
请求示例:
{
"createTime": "",
"id": "",
"isRead": "",
"modifyTime": "",
"msgContent": "",
"receiveId": "",
"receiveType": "",
"sendUserId": "",
"state": "",
"type": ""
}
请求参数:
参数名称 | 参数说明 | in | 是否必须 | 数据类型 | schema |
---|---|---|---|---|---|
request | request | body | true | 消息表 | 消息表 |
schema属性说明
消息表
参数名称 | 参数说明 | in | 是否必须 | 数据类型 | schema |
---|---|---|---|---|---|
createTime | 创建时间 | body | false | string(date-time) | |
id | 消息编码 | body | false | string | |
isRead | 消息已读状态: 1:已读 2:未读 | body | false | string | |
modifyTime | 修改时间 | body | false | string(date-time) | |
msgContent | 消息内容 | body | true | string | |
receiveId | 接收者编码,接收者可能是群或者个人 | body | true | string | |
receiveType | 接收人类型 1:个人 2:群 | body | true | string | |
sendUserId | 发送人编码 | body | true | string | |
state | 消息状态 1:有效 2:无效 | body | false | string | |
type | 消息类型 1:文本 2:文件(图片属于文件) | body | true | string |
响应示例:
{
"code": 0,
"data": {},
"msg": ""
}
响应参数:
参数名称 | 参数说明 | 类型 | schema |
---|---|---|---|
code | integer(int32) | integer(int32) | |
data | object | ||
msg | string |
响应状态:
状态码 | 说明 | schema |
---|---|---|
200 | OK | ResponseResult |
201 | Created | |
401 | Unauthorized | |
403 | Forbidden | |
404 | Not Found |
此处可能存在不合适展示的内容,页面不予展示。您可通过相关编辑功能自查并修改。
如您确认内容无涉及 不当用语 / 纯广告导流 / 暴力 / 低俗色情 / 侵权 / 盗版 / 虚假 / 无价值内容或违法国家有关法律法规的内容,可点击提交进行申诉,我们将尽快为您处理。