API 명세서 3. Milestone

Mileston State

{
    0: close,
    1: opened
}

마일스톤 목록 조회

GET /api/milestone?state

• Request query (바디X)

/api/milestone?state=0 (closed)
/api/milestone?state=1 (open)

• Response Status code

code	설명
200	정상적으로 생성
401	헤더에 토큰을 실지 않는 경우 (로그인 X)
500	내부 서버 에러

• Response

{
    "message": "The request is successfully processed"
    "data": [
        {
            "id": Number,
            "title": String,
            "description": String,
            "date": Date
            "open": Number,
            "closed": Number,
            "state": Number (0 | 1)
        }
    ]
}

마일스톤 세부 조회

GET /api/milestone/{milestoneId}

• Response Status code

code	설명
200	정상적으로 생성
401	헤더에 토큰을 실지 않는 경우 (로그인 X)
404	uri에 있는 id를 가지는 마일스톤이 존재하지 않는 경우
500	내부 서버 에러

• Response

{
    "message": "The request is successfully processed"
    "data": {
        "id": Number,
        "title": String,
        "description": String,
        "date": Date,
        "state": Number (0 | 1)
    }
}

마일스톤 추가

POST /api/milestone

• Request

{
    "title": String (required),
    "description": String,
    "date": Date
}

• Response Status code

code	설명
200	정상적으로 생성
400	request body가 정상적이지 않은 경우 (타이틀 필드는 필수)
401	헤더에 토큰을 실지 않는 경우 (로그인 X)
500	내부 서버 에러

• Response

{
    "message": "The request is successfully processed"
}

마일스톤 갱신

PUT /api/milestone/{milestoneId}

• Request

{
    "title": String (required),
    "description": String,
    "date": Date
}

• Response Status code

code	설명
200	정상적으로 생성
400	request body가 정상적이지 않은 경우 (타이틀 필드는 필수)
401	헤더에 토큰을 실지 않는 경우 (로그인 X)
404	해당 아이디를 가지는 마일스톤이 없는 경우
500	내부 서버 에러

• Response

{
    "message": "The request is successfully processed"
}

마일스톤 삭제

DELETE /api/milestone/{milestoneId}

• Response Status code

code	설명
200	정상적으로 삭제
401	헤더에 토큰을 실지 않는 경우 (로그인 X)
404	해당 id를 가지는 마일스톤이 존재하지 않는 경우
500	내부 서버 에러

• Response

{
    "message": "The request is successfully processed"
}

마일스톤 상태 갱신 (toggle)

PUT /api/milestone/{milestoneId}/state

• Request

{
    "state": 0 || 1 (변경하고자 하는 값)
}

• Response Status code

code	설명
200	정상적으로 삭제
401	헤더에 토큰을 실지 않는 경우 (로그인 X)
404	해당 id를 가지는 마일스톤이 존재하지 않는 경우
500	내부 서버 에러

• Response

{
    "message": "The request is successfully processed"
}