MILESTONE API

Milestone API 개요

METHOD	URL	DESCRIPITION
GET	/api/milestone	milestone list 가져오기
POST	/api/milestone	milestone 생성
PATCH	/api/milestone/:milestoneId	comment 수정
DELETE	/api/milestone/:milestoneId	comment 삭제

Milestone Get API

request

URL

GET /api/milestone

response

[
    {
        "id": 1,
        "title": "first week",
        "description": "first description",
        "dueDate": null,
        "isOpen": false,
        "createdAt": "2020-11-02T16:40:56.000Z",
        "updatedAt": "2020-11-03T06:29:36.000Z",
        "issues": [
            {
                "id": 1,
                "title": "first issue",
                "isOpen": true,
                "createdAt": "2020-11-02T16:40:56.000Z",
                "updatedAt": "2020-11-02T16:40:56.000Z",
                "createrId": 1,
                "milestoneId": 1
            },
            {
                "id": 2,
                "title": "second issue",
                "isOpen": true,
                "createdAt": "2020-11-02T16:40:56.000Z",
                "updatedAt": "2020-11-02T16:40:56.000Z",
                "createrId": 1,
                "milestoneId": 1
            }
        ]
    }
]

Milestone create API

request

URL

POST /api/milestone

Body

NAME	TYPE	DESCRIPITION	REQUIRED
title	String	마일스톤 제목	O
description	String	마일스톤 설명	X
dueDate	Date	기한	X
isOpen	Boolean	오픈 여부(default true)	X

JSON example

{
    "title": "title goes here",
    "description": "description goes here", 
    "dueDate": "2020-11-02T16:40:56.000Z", 
    "isOpen": true
}

response

{
    "id": 4,
    "title": "title goes here",
    "description": "description goes here",
    "dueDate": "2020-11-02T16:40:56.000Z",
    "isOpen": true,
    "updatedAt": "2020-11-03T06:28:33.924Z",
    "createdAt": "2020-11-03T06:28:33.924Z"
}

Milestone update API

request

URL

PATCH /api/milestone/:milestoneId

Body

NAME	TYPE	DESCRIPITION	REQUIRED
title	String	마일스톤 제목	X
description	String	마일스톤 설명	X
dueDate	Date	기한	X
isOpen	Boolean	오픈 여부(default true)	X

JSON example

{
	"isOpen": false
}

response

{
    "numOfaffectedRows": 1
}

Milestone delete API

request

URL

DELETE /api/milestone/:milestoneId

response

{
    "numOfaffectedRows": 1
}