%F0%9F%9A%80 JOURNEY %F0%9F%9A%80 - Polaris-Sopterm/Polaris-BACKEND GitHub Wiki

목차




1️⃣ 여정 생성 API

Decription

여정을 생성합니다.
USER 권한이 필요합니다. (로그인한 상태가 아니라면 에러가 발생합니다.)

Request

EndPoint

POST /journey/v0

Header

application/json

Body Parameter

parameter Type Description
title string 여정 제목
value1 string(enum) 여정 가치1
value2 string(enum) 여정 가치2(2는 필수가 아닙니다.)
year int 여정 목표 년도
month int 여정 목표 달
weekNo int 여정 목표 주차

Response

{
  "idx": {integer},
  "title": {string},
  "value1": {string(enum)},
  "value2": {string(enum)},
}




2️⃣ 여정 수정 API

Decription

여정의 제목과 가치를 수정할 수 있습니다. USER 권한이 필요합니다. (로그인한 상태가 아니라면 에러가 발생합니다.)

default 여정일 경우 제목만 수정 불가합니다.가치는 수정할 수 있습니다.

Request

EndPoint

PATCH /journey/v0/:journeyIdx

Header

application/json

Body Parameter

parameter Type Description
title string 여정 제목
value1 string(enum) 여정 가치1
value2 string(enum) 여정 가치2
  • 여정 제목과 가치는 필수가 아닙니다.(ex: 제목만 변경하는 경우 제목만 body에 포함되면 됨)
  • 그러나, 가치를 변경하면 value1과 value2 모두 body에 포함되어야 합니다.

Response

{
  "idx": {integer},
  "title": {string},
  "value1": {string(enum)},
  "value2": {string(enum)},
}




3️⃣ 여정 제목 목록 조회 API

Decription

여정 제목 목록을 반환합니다. (날짜별 할 일 생성에서 필요합니다.)
USER 권한이 필요합니다. (로그인한 상태가 아니라면 에러가 발생합니다.)

Request

EndPoint

GET /journey/v0/title?date

  • query param인 date가 없으면 에러가 발생합니다.

Header

application/json

Response

[ 
  {
    "idx": {integer},
    "title": {string},
    "year": {integer},
    "month": {integer},
    "weekNo": {integer},
    "userIdx": {integer},
  },
]




4️⃣ 여정 목록 조회 API

Decription

홈화면에서 사용자가 가입한 이후의 주차 리스트와 여정 목록을 반환합니다.
(주차 리스트는 다음주와 다다음주에 대한 주차 정보도 포함되어 있습니다. 마지막 2개는 다음주, 다다음주로 변경해야 합니다.)
USER 권한이 필요합니다. (로그인한 상태가 아니라면 에러가 발생합니다.)

Request

EndPoint

GET /journey/v0?year=2021&month=05&weekNo=3

  • query param인 year, month, weekNo가 없으면 에러가 발생합니다.

Header

Response

  • 여정이 없는 경우, idx는 null이며 value1과 value2는 랜덤 가치를 반환합니다.
{
    "weekList": [
        {
            "year": {integer},
            "month": {integer},
            "weekNo": {integer}
        },
    ],
    "journeys": [
        {
            "idx": {integer},
            "title": {string},
            "year": {integer},
            "month": {integer},
            "weekNo": {integer},
            "userIdx": {integer},
            "value1": {string},
            "value2": {string},
            "toDos": [
                {
                    "idx": {integer},
                    "title": {string},
                    "date": {string},
                    "isTop": {boolean},
                    "isDone": {string}
                },
            ]
        },
    ]
}




5️⃣ 여정 삭제 API

Decription

여정을 삭제합니다. (날짜별 할 일 생성에서 필요합니다.)
USER 권한이 필요합니다. (로그인한 상태가 아니라면 에러가 발생합니다.)

Request

EndPoint

DELETE /journey/v0/:journeyIdx

Header

application/json

Response

예시

200

{
  "isSuccess": true
},
⚠️ **GitHub.com Fallback** ⚠️