재구성 해본 api

1. User

   • GET : 사용자 유저 조회

     • Body:

       • user:

       {
         "user": {
           "id": 0,
           "username": "string",
           "nickname": "string",
           "auth_id": "string",
           "snowball_count": 0,
           "main_snowball_id": 0,
           "snowball_list": [
             0
           ],
           "message_count": 0
         },
         "main_snowball": {
           "title": "string",
           "id": 0,
           "is_message_private": true,
           "main_decoration_id": 0,
           "main_decoration_color": "string",
           "bottom_decoration_id": 0,
           "bottom_decoration_color": "string",
           "message_list": [
             {
               "id": 0,
               "decoration_id": 0,
               "decoration_color": "string",
               "letter_id": 0,
               "content": "string",
               "sender": "string",
               "opened": "2023-12-05T07:44:14.115Z",
               "created": "2023-12-05T07:44:14.115Z",
               "sentiment": "string",
               "confidence": 0,
               "location": 0
             }
           ]
         }
       }
       

     • 닉네임을 설정하지 않거나 첫 유저인 경우

       • 닉네임을 null로 정해줌
       • main_snowball 배열이 빈 배열로 전달
   • GET /{auth_id} : 방문자 유저 조회
     • 위와 동일
     • private시에는 letter_id, content, sender는 제외하여 반환
   • PUT 사용자 정보 변경

     • Request

       • nickname

     • Response

       {
         "nickname": "string"
       }
       

2. Snowball

   • POST : 스노우볼 생성

     • Request Body:

       • example

       {
         "title": "string",
         "main_decoration_id": 0,
         "main_decoration_color": "#FFFFFF",
         "bottom_decoration_id": 0,
         "bottom_decoration_color": "#FFFFFF",
         "is_message_private": true
       }
       

     • Response :

       • 201 Created
       • Body:

       {
         "title": "string",
         "id": 0,
         "is_message_private": true,
         "main_decoration_id": 0,
         "main_decoration_color": "string",
         "bottom_decoration_id": 0,
         "bottom_decoration_color": "string",
         "message_list": []
       }
       
       

   • PUT /{snowball_id} : 스노우볼 설정 업데이트

     • Request Body:

       {
         "title": "string",
         "is_message_private": true
       }
       

     • Response:

       • 200 OK
       • Body

       {
         "snowball_id": 0,
         "title": "string",
         "is_message_private": true
       }
       

   • GET /{snowball_id} : 스노우볼 조회

     • Response:

       • 200 OK

       • Body:

         {
           "title": "string",
           "id": 0,
           "is_message_private": true,
           "main_decoration_id": 0,
           "main_decoration_color": "string",
           "bottom_decoration_id": 0,
           "bottom_decoration_color": "string",
           "message_list": [
             {
               "id": 0,
               "decoration_id": 0,
               "decoration_color": "string",
               "letter_id": 0,
               "content": "string",
               "sender": "string",
               "opened": "2023-12-05T07:48:07.142Z",
               "created": "2023-12-05T07:48:07.142Z",
               "sentiment": "string",
               "confidence": 0,
               "location": 0
             }
           ]
         }
         

   • PUT /{snowball_id}/decoration : 스노우볼 메인 장식 업데이트

     • Request Body:

       {
         "main_decoration_id": 0,
         "main_decoration_color": "#FFFFFF",
         "bottom_decoration_id": 0,
         "bottom_decoration_color": "#FFFFFF"
       }
       

     • Response:

       • 200 OK
       • Body: 반영된 정보

       {
         "main_decoration_id": 0,
         "main_decoration_color": "#FFFFFF",
         "bottom_decoration_id": 0,
         "bottom_decoration_color": "#FFFFFF"
       }
       
       

3. Message:

   • POST /message/{snowball_id} : 메세지 생성

     • Request Body:

       {
         "sender": "string",
         "content": "string",
         "decoration_id": 1,
         "decoration_color": "#FFFFFF",
         "letter_id": 1
       }
       

     • Response:

       • 201 Created

       • Body: 갱신한 정보

         {
           "sender": "string",
           "content": "string",
           "location": 0,
           "sentiment": "string",
           "confidence": 0
         }
         

   • DELETE /{message_id} : 메세지 삭제

     • Response:
       • 204 No content

   • GET : 메세지 조회

     • Response:

       [
         {
           "id": 0,
           "decoration_id": 0,
           "decoration_color": "string",
           "letter_id": 0,
           "content": "string",
           "sender": "string",
           "opened": "2023-12-05T07:48:21.674Z",
           "created": "2023-12-05T07:48:21.674Z",
           "sentiment": "string",
           "confidence": 0,
           "location": 0
         }
       ]
       

   • PUT /{message_id} : 메세지 오픈 처리

     • Response:

     
       "id": 0,
       "decoration_id": 0,
       "decoration_color": "string",
       "letter_id": 0,
       "content": "string",
       "sender": "string",
       "opened": "2023-12-05T07:49:12.729Z",
       "created": "2023-12-05T07:49:12.729Z",
       "sentiment": "string",
       "confidence": 0,
       "location": 0
     }
     

   1. Authentication:
      • Google:
        • GET /auth/google
          • Response:
            • 200 OK
      • Naver:
        • GET /auth/naver
          • Response
            • 위와 동일
      • Kakao:
        • GET /auth/kakao
          • Response:
            • 위와 동일

flowchart TD
    A[App Module] <--- B[Auth Module]
		A <--- C[User Module]
		C <--- D[Snowball Module]
		D <--- E[Message Module]