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는 또한 일부 소켓.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 — 소켓.io 클라이언트의 연결입니다.mount-chat — 특정 :chatId 사용한 채팅 메시지를 수신하기 위해 클라이언트를 마운트합니다.unmount-chat — 특정 :chatId 사용한 채팅 메시지 수신 대기에서 클라이언트를 해제합니다.send-message — 채팅할 content 포함된 메시지 보내기 MIT © 데니스 도브한(Denys Dovhan)
