Skip to content

Week Theme API 문서

이종훈 edited this page Sep 3, 2024 · 2 revisions
테마는 생성형 AI에 의해 일요일 오후 7시에 생성됩니다.

가족 구성원은 생성된 테마 중 1개를 고를 수 있습니다.

다수결에 의해 월요일 아침 7시에 이주의 테마가 선정됩니다.

(만약 동률일 경우 선택된 내용 중 랜덤하게 배정됩니다. 아무 테마도 선택되지 않을 경우 랜덤으로 테마가 배정됩니다.)

이주의 테마 전체 조회

Request

Method: GET
Endpoint: /api/v1/themes

Request Body

Key Description
userToken 유저 대체키
themeToken 테마 대체키

Response

HTTP/1.1 200 Ok
Content-Type: application/json

{
    "code" : 200,
    "message" : "요청에 성공하셨습니다.",
    "data" : {
        "themeList" : [ {
            "subject" : "축구",
            "week" : "8"
            },
            ...
        ]
    }
}

Response Fields

Path Type Description
code Number 결과 코드
message String 결과 메세지
data.themeList[].subject String 테마 주제
data.themeList[].week Number 테마 지정 주

이주의 테마 단건 조회

Request

Method: GET
Endpoint: /api/v1/themes/{themeToken}

Request Body

Key Description
userToken 유저 대체키
themeToken 테마 대체키

Response

HTTP/1.1 200 Ok
Content-Type: application/json

{
    "code" : 200,
    "message" : "요청에 성공하셨습니다.",
    "data" : {
        "subject" : "축구"
  }
}

Response Fields

Path Type Description
code Number 결과 코드
message String 결과 메세지
data.subject String 테마 주제

이주의 테마 댓글 생성

Request

Method: POST
Endpoint: /api/v1/themes/comment

Request Body

Key Description
userToken 유저 대체키
themeToken 테마 대체키
content 댓글 내용

Response

HTTP/1.1 201 Created
Content-Type: application/json

{
    "code" : 201,
    "message" : "요청에 성공하셨습니다.",
    "data" : {
        "themeCommentToken" : "thc_evlkjsdfh"
  }
}

Response Fields

Path Type Description
code Number 결과 코드
message String 결과 메세지
data.themeCommentToken String 테마 댓글 대체키

이주의 테마 댓글 조회

Request

Method: GET
Endpoint: /api/v1/themes/comment?themeToken=thm_alkjsdfoi

Request Body

Key Description
userToken 유저 대체키
themeToken 테마 대체키

Response

HTTP/1.1 200 Ok
Content-Type: application/json

{
    "code" : 200,
    "message" : "요청에 성공하셨습니다.",
    "data" : {
        "themeCommentList" : [ {
            "content" : "축구 댓글",
            "createdAt" : "2024-08-28T00:00:00"
            "modifiedAt" : "2024-08-28T00:00:00"
            }
            ...
        ]
    }
}

Response Fields

Path Type Description
code Number 결과 코드
message String 결과 메세지
data.themeCommentList[].content String 테마 댓글
data.themeCommentList[].createdAt String 테마 댓글 생성일
data.themeCommentList[].modifiedAt String 테마 댓글 수정일

Clone this wiki locally