title

language_tabs

toc_footers

includes

search

code_clipboard

highlight_theme

headingLevel

generator

聊天室

shell
Shell

http
HTTP

javascript
JavaScript

ruby
Ruby

python
Python

php
PHP

java
Java

go
Go

true

darkula

2

@tarslib/widdershins v4.0.23

聊天室

Base URLs:

腾讯云服务器: http://122.51.134.156:8080

Authentication

Default

POST 用户注册

POST /user/register

Body 请求参数

{
  "username": "jianghaohuan",
  "password": "jhh72811",
  "nickname": "蒋昊寰",
  "email": "2474510393@qq.com"
}

请求参数

名称	位置	类型	必选	说明
body	body	object	否	none
» id	body	integer	是	用户ID（主键）
» username	body	string	否	用户名
» password	body	string	否	密码（加密储存）
» nickname	body	string	是	用户昵称
» email	body	string	否	邮箱

返回示例

成功

{
  "success": true,
  "message": "注册成功！"
}

{
  "success": false,
  "message": "用户已存在..."
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	中文名	说明
» success	boolean	true	none		是否成功
» message	string	true	none		信息

POST 添加联系人

POST /contacts/add

Body 请求参数

{
  "id": 1780617997957279700
}

请求参数

名称	位置	类型	必选	说明
token	header	string	否	用户的token
body	body	object	否	none
» id	body	integer	是	用户ID（主键）

返回示例

成功

{
  "success": true,
  "message": "添加联系人成功"
}

{
  "success": false,
  "message": "该联系人已经存在"
}

{
  "success": false,
  "message": "该用户不存在"
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	中文名	说明
» success	boolean	true	none		是否成功
» message	string	true	none		返回信息

POST 创建会话

POST /conversation/create

Body 请求参数

{}

请求参数

名称	位置	类型	必选	说明
contactId	query	array[string]	否	none
token	header	string	否	发起会话的token
body	body	object	否	none

返回示例

成功

{
  "success": true,
  "message": "创建成功！"
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	中文名	说明
» success	boolean	true	none		是否成功
» message	string	true	none		返回信息

GET 获取消息记录

GET /message/history/{conversation_id}

请求参数

名称	位置	类型	必选	说明
conversation_id	path	string	是	none
token	header	string	否	none

返回示例

成功

{
  "success": true,
  "message": "查找成功",
  "data": []
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	中文名	说明
» success	boolean	true	none		是否成功
» message	string	true	none		返回信息

GET 获取会话列表

GET /conversation/getlist

请求参数

名称	位置	类型	必选	说明
token	header	string	否	none

返回示例

成功

{
  "success": true,
  "message": "查找会话成功！",
  "data": [
    1780617157418758100
  ]
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	中文名	说明
» success	boolean	true	none		是否成功
» message	string	true	none		返回信息

POST 用户登录

POST /user/login

Body 请求参数

{
  "username": "SmilingSea",
  "password": "jhh72811"
}

请求参数

名称	位置	类型	必选	说明
body	body	object	否	none
» id	body	integer	是	用户ID（主键）
» username	body	string	否	用户名
» password	body	string	否	密码（加密储存）

返回示例

成功

{
  "success": true,
  "message": "登录成功！",
  "token": {
    "id": 1780614447533469700,
    "token": "eyJhbGciOiJIUzI1NiJ9.eyJ1aWQiOjE3ODA2MTQ0NDc1MzM0Njk2OTcsImV4cCI6MTcxMzk3MTM0NX0.-Mb2XIkiaJuWp2O1T6MtPfIzY4_w279w_qgkENP8v_Q"
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» success	boolean	true	none	是否成功
» message	string	true	none	返回信息
» token	string	true	none	用户token

DELETE 删除联系人

DELETE /contacts/remove/{contactId}

请求参数

名称	位置	类型	必选	说明
contactId	path	integer(long)	是	none
token	header	string	否	none

返回示例

成功

{
  "success": false,
  "message": "删除联系人成功"
}

{
  "success": false,
  "message": "该联系人不存在"
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	中文名	说明
» success	boolean	true	none		是否成功
» message	string	true	none		返回信息

GET 获取会话成员(不包含用户本身）

GET /conversation/members

请求参数

名称	位置	类型	必选	说明
conversationId	query	string	否	none
token	header	string	否	none

返回示例

成功

{
  "success": true,
  "message": "查询会话成员成功！",
  "data": [
    1780615458549477400
  ]
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	中文名	说明
» success	boolean	true	none		是否成功
» message	string	true	none		返回信息

GET 查询联系人列表

GET /contacts/list

请求参数

名称	位置	类型	必选	说明
token	header	string	否	用户的token

返回示例

成功

{
  "success": true,
  "message": "查找成功！",
  "data": [
    1780615458549477400
  ]
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	中文名	说明
» success	string	true	none		是否成功
» contacts	string	true	none		none

GET 用id查询用户信息

GET /user/profile/{id}

请求参数

名称	位置	类型	必选	说明
id	path	string	是	none
token	header	string	否	用户的token

返回示例

成功

{
  "success": false,
  "message": "缺少token或token无效"
}

{
  "success": true,
  "message": "查询成功！",
  "data": {
    "id": 1780614447533469700,
    "username": "jianghaohuan",
    "nickname": "蒋昊寰",
    "email": "2474510393@qq.com",
    "authority": "0"
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» success	boolean	true	none	是否成功
» id	integer	true	none	用户ID（主键）
» username	string	false	none	用户名
» nickname	string	true	none	用户昵称
» email	string	false	none	邮箱
» authority	string	true	none	权限

POST 上传图片

POST /message/image

Body 请求参数

image: file://E:\下载\王老吉.png

请求参数

名称	位置	类型	必选	说明
token	header	string	否	none
body	body	object	否	none
» image	body	string(binary)	否	none

返回示例

成功

{
  "success": true,
  "message": "https://improject-1322480945.cos.ap-nanjing.myqcloud.com/picture/1780617840125620225.png",
  "data": "上传成功"
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	中文名	说明
» success	boolean	true	none		是否成功
» message	string	true	none		返回信息

POST 屏蔽用户

POST /user/ban/{bannerId}

Body 请求参数

{}

请求参数

名称	位置	类型	必选	说明
bannerId	path	string	是	屏蔽人id
token	header	string	否	none
body	body	object	否	none

返回示例

成功

{
  "success": true,
  "message": "屏蔽成功！"
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	中文名	说明
» success	boolean	true	none		是否成功
» message	string	true	none		返回信息

DELETE 移除屏蔽

DELETE /user/unban/{bannerId}

请求参数

名称	位置	类型	必选	说明
bannerId	path	string	是	none
token	header	string	否	none

返回示例

记录不存在

{
  "success": true,
  "message": "移除成功！"
}

{
  "success": false,
  "message": "该用户未被屏蔽"
}

返回结果

状态码	状态码含义	说明	数据模型
404	Not Found	记录不存在	Inline

返回数据结构

状态码 404

名称	类型	必选	约束	说明
» timestamp	string	true	none	none
» status	integer	true	none	none
» error	string	true	none	none
» message	string	true	none	none
» path	string	true	none	none

GET 根据token查用户信息

GET /user/profile

请求参数

名称	位置	类型	必选	说明
token	header	string	否	none

返回示例

成功

{
  "success": false,
  "message": "缺少token或token无效"
}

{
  "success": true,
  "message": "查询成功！",
  "data": {
    "id": 1780614447533469700,
    "username": "jianghaohuan",
    "password": "a049334946107e2bfbf8536bdfaeb922",
    "nickname": "蒋昊寰",
    "email": "2474510393@qq.com",
    "authority": "0",
    "createdAt": "2024-04-17T15:09:01",
    "updatedAt": "2024-04-17T15:09:01"
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	中文名	说明
» success	boolean	true	none		是否成功
» message	string	true	none		返回信息

数据模型

User

{
  "id": -2147483648,
  "username": "string",
  "password": "string",
  "nickname": "string",
  "email": "string",
  "authority": "string",
  "created_at": "string",
  "updated_at": "string"
}

属性

名称	类型	必选	约束	说明
id	integer	true	none	用户ID（主键）
username	string	false	none	用户名
password	string	false	none	密码（加密储存）
nickname	string	true	none	用户昵称
email	string	false	none	邮箱
authority	string	true	none	权限
created_at	string	false	none	创建时间
updated_at	string	false	none	更新时间

Messages

{
  "id": -2147483648,
  "conversation_id": -2147483648,
  "sender_id": -2147483648,
  "receiver_id": -2147483648,
  "content": "string",
  "type": "text",
  "sent_at": "string",
  "received_at": "string"
}

属性

名称	类型	必选	约束	说明
id	integer	true	none	消息ID（主键）
conversation_id	integer	false	none	会话ID
sender_id	integer	false	none	发送者ID
receiver_id	integer	false	none	接收者ID
content	string	false	none	消息内容
type	string	false	none	消息类型（文字、图片）
sent_at	string	false	none	发送时间
received_at	string	false	none	接受时间

枚举值

属性	值
type	text
type	image

Conversations

{
  "id": -2147483648,
  "type": "single",
  "created_at": "string",
  "updated_at": "string"
}

属性

名称	类型	必选	约束	说明
id	integer	true	none	会话ID（主键）
type	string	false	none	会话类型（单聊、群聊）
created_at	string	false	none	创建时间
updated_at	string	false	none	更新时间

枚举值

属性	值
type	single
type	group

Contacts

{
  "id": -2147483648,
  "user_id": -2147483648,
  "contact_id": -2147483648,
  "created_at": "string",
  "updated_at": "string"
}

属性

名称	类型	必选	约束	说明
id	integer	true	none	联系人关系ID（主键）
user_id	integer	false	none	用户ID
contact_id	integer	false	none	联系人ID 联系人ID
created_at	string	false	none	创建时间
updated_at	string	false	none	更新时间

Files

接口文档.md

Latest commit

History

接口文档.md

File metadata and controls

聊天室

Authentication

Default

POST 用户注册

请求参数

返回结果

返回数据结构

POST 添加联系人

请求参数

返回结果

返回数据结构

POST 创建会话

请求参数

返回结果

返回数据结构

GET 获取消息记录

请求参数

返回结果

返回数据结构

GET 获取会话列表

请求参数

返回结果

返回数据结构

POST 用户登录

请求参数

返回结果

返回数据结构

DELETE 删除联系人

请求参数

返回结果

返回数据结构

GET 获取会话成员(不包含用户本身）

请求参数

返回结果

返回数据结构

GET 查询联系人列表

请求参数

返回结果

返回数据结构

GET 用id查询用户信息

请求参数

返回结果

返回数据结构

POST 上传图片

请求参数

返回结果

返回数据结构

POST 屏蔽用户

请求参数

返回结果

返回数据结构

DELETE 移除屏蔽

请求参数

返回结果

返回数据结构

GET 根据token查用户信息

请求参数

返回结果

返回数据结构

数据模型

User

属性

Messages

属性

枚举值

Conversations

属性

枚举值

Contacts

属性