react chat api
1.0.0
DogeCodes React コース用のチャット アプリケーションの API。
これは、DogeCodes React Chat アプリケーションの動作を修正するために必要なロジックを実装する単純な API サーバーです。
このサーバーをローカルで実行するには、次の要件が必要です。
この 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
を使用してチャットを終了します。API のデバッグに Insomnia を使用している場合は、ワークスペースのバックアップをダウンロードできます。
.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
を含むメッセージを送信しますMIT © デニス・ドヴァン