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