react chat api
1.0.0
DogeCodes React 课程的聊天应用程序 API。
这是一个简单的 API 服务器,它实现了正确处理 DogeCodes React Chat 应用程序所需的逻辑。
要在本地运行此服务器,您需要满足以下要求:
使用以下命令在本地运行此 API 服务器:
git clone https://github.com/dogecodes/react-chat-api.git
cd react-chat-api
npm install
npm run start:dev # or `npm start` for production
注意:不要忘记启动mongod
来连接数据库。
当前 API 版本为v1
,因此您需要在每个路由之前指定 API 版本。例如:
http://localhost:8000/v1/users/me
http://localhost:8000/v1/chats
以下是 API 的 HTTP 路由图:
/
— 与身份验证相关的路由。/signup
POST — 使用username
和password
创建新用户。/login
POST — 使用username
和password
登录用户。/logout
GET — 注销活动用户。/users
— 与用户相关的路由。/users
GET — 检索有关所有用户的数据。/users/me
GET — 检索我的用户数据。/users/me
POST — 更新我的用户信息( username
、 firstName
、 lastName
和city
)。/users/:id
GET — 检索有关具有特定:id
的用户的信息。/chats
— 与聊天相关的路由。/chats
GET — 检索有关所有聊天的信息。/chats
POST — 创建具有指定title
的新聊天。/chats/my
GET — 获取所有用户的聊天列表。/chats/:id
GET — 通过特定聊天的:id
获取聊天信息和消息。/chats/:id
POST — 发送新消息以与特定:id
聊天。/chast/:id
DELETE — 删除特定:id
聊天。只有聊天的创建者才能删除它。/chats/:id/join
GET — 加入特定:id
的聊天。/chats/:id/leave
GET — 使用特定的:id
留下聊天。如果您使用 Insomnia 来调试 API,则可以下载工作区备份:
下载.zip
该 API 还发出并侦听一些 socket.io 事件。
套接字连接需要使用访问令牌进行身份验证。下面是建立套接字连接的示例:
import SocketIOClient from 'socket.io-client' ;
socket = SocketIOClient ( 'path/to/api' , {
query : {
token : '...your access-token here...' ,
} ,
} ) ;
以下是活动列表:
new-message
— 当有人向特定聊天发送新消息时发出。new-chat
— 当有人创建新聊天时发出。deleted-chat
— 当有人删除聊天时发出。 connection
— socket.io 客户端的连接。mount-chat
— 安装客户端以监听特定:chatId
的聊天消息。unmount-chat
— 取消客户端监听特定:chatId
的聊天消息。send-message
— 发送带有聊天content
消息麻省理工学院 © Denys Dovhan