chatroom

<aside> 💡

채팅방 조회

• 채팅방 목록을 조회합니다
• userId로 검색할 수 있고, 페이지네이션이 가능합니다
• HTTP 메소드: GET
• URI: /chatroom
• 요청 헤더: Authorization: Bearer 액세스토큰
• 요청 데이터:
  • query
    • page: number (nullable)
    • pageSize: number (nullable)
• 응답 데이터:

{
    "code": 200,
    "message": "채팅방 조회가 완료되었습니다.",
    "data": [
        {
            "id": "66a9c94c783b7b9456c6f1f2",
            "title": "donghyun, test1",
            "type": "private",
            "userIds": [
                "donghyun",
                "test1"
            ],
            "lastMessage": "hello",
            "unreadCount": 0,
            "isJoined": true, // false의 경우, 새로운 채팅방이므로 조인하는 로직 필요`
            "createdAt": "Wed Jul 31 2024 14:19:08 GMT+0900 (Korean Standard Time)",
            "updatedAt": "Wed Jul 31 2024 14:27:10 GMT+0900 (Korean Standard Time)"
        }
    ],
    "meta": {
        "page": 1,
        "pageSize": 10,
        "total": 1,
        "pageCount": 1,
        "hasPreviousPage": false,
        "hasNextPage": false
    }
}

</aside>

<aside> 💡 채팅방 생성

• 채팅방을 생성합니다

• 유저가 게시글을 올린 유저에게 채팅 신청을 하면 채팅방이 생성되고 두 유저가 소켓으로 접속하는 형식

• HTTP 메소드: POST

• URI: /chatroom

• 요청 헤더: Authorization: Bearer 액세스토큰

• 요청 데이터:

  • body

  {
      "title": "chatroom2",
      "type": "private", // (private or group
      "userIds": ["donghyun", "test1"]
  }
  

• 응답 데이터:

{
    "code": 200,
    "message": "채팅방이 생성되었습니다.",
    "data": {
        "id": "664e1bdc14426cbe69b15ce9",
        "title": "chatroom2",
        "type": "private",
        "createdAt": "Thu May 23 2024 01:22:52 GMT+0900 (Korean Standard Time)",
        "updatedAt": "Thu May 23 2024 01:22:52 GMT+0900 (Korean Standard Time)"
    }
}

</aside>

<aside> 💡 채팅방 삭제 (soft delete)

• 채팅방을 삭제합니다
• HTTP 메소드: DELETE
• URI: /chatroom/:id
• 요청 헤더: Authorization: Bearer 액세스토큰
• 요청 데이터:
  • path: :id (chatroomId)
• 응답 데이터:

{
    "code": 200,
    "message": "채팅방이 삭제되었습니다."
}

</aside>

chat

<aside> 💡 채팅방 별 채팅 목록 조회

• 채팅방 별 채팅 목록을 조회합니다
• chatroomId로 검색할 수 있고, 페이지네이션이 가능합니다
• HTTP 메소드: GET
• URI: /chat/:chatroomId
• 요청 헤더: Authorization: Bearer 액세스토큰
• 요청 데이터:
  • path
    • chatroomId: string
  • query
    • page: number (nullable)
    • pageSize: number (nullable)
• 응답 데이터:

{
    "code": 200,
    "message": "조회가 완료되었습니다.",
    "data": [
        {
            "message": "image",
            "user": {
                "userId": "donghyun",
                "nickname": "동현닉넴",
                "profileImage": null,
                "birthYear": "2004",
                "phoneNumber": "01066663333",
                "role": "user",
                "state": "가입",
                "createdAt": "2024-05-20T13:14:12.418Z",
                "updatedAt": "2024-05-20T13:14:41.760Z",
                "deletedAt": null
            },
            "chatroomId": "66a9be9e894e2fd1784b3632",
            "fileType": "image",
            "fileUrl": "<https://michi-bucket.s3.ap-northeast-2.amazonaws.com/027c907d_9e29_4354_a4b3_716740587247_A86E8D4A-D5A3-415A-9146-7F8312DBF9EC.jpg>",
            "createdAt": "2024-07-31T04:57:37.012Z"
        },
        {
            "message": "image",
            "user": {
                "userId": "donghyun",
                "nickname": "동현닉넴",
                "profileImage": null,
                "birthYear": "2004",
                "phoneNumber": "01066663333",
                "role": "user",
                "state": "가입",
                "createdAt": "2024-05-20T13:14:12.418Z",
                "updatedAt": "2024-05-20T13:14:41.760Z",
                "deletedAt": null
            },
            "chatroomId": "66a9be9e894e2fd1784b3632",
            "fileType": "image",
            "fileUrl": "<https://michi-bucket.s3.ap-northeast-2.amazonaws.com/027c907d_9e29_4354_a4b3_716740587247_A86E8D4A-D5A3-415A-9146-7F8312DBF9EC.jpg>",
            "createdAt": "2024-07-31T05:04:17.610Z"
        }
    ],
    "meta": {
        "page": 1,
        "pageSize": 10,
        "total": 2,
        "pageCount": 1,
        "hasPreviousPage": false,
        "hasNextPage": false
    }
}

</aside>

<aside> 💡 랜덤 채팅 시작

• 랜덤 채팅을 시작합니다
• HTTP 메소드: POST
• URI: /chat/random
• 요청 헤더: Authorization: Bearer 액세스토큰
• 요청 데이터
  • query
    • page: number (nullable)
    • pageSize: number (nullable)
• 응답 데이터: data 필드에는 chatroom dto가 반환됩니다

{
    "code": 200,
    "message": "eunli님과 채팅을 시작합니다.",
    "data": {
        "id": "6670367f22b1c7243997a249",
        "title": "donghyun, eunli",
        "type": "private",
        "createdAt": "Mon Jun 17 2024 22:13:35 GMT+0900 (Korean Standard Time)",
        "updatedAt": "Mon Jun 17 2024 22:13:35 GMT+0900 (Korean Standard Time)"
    }
}

</aside>