Skip to content

API Milestone

Ahrim Yang edited this page Nov 11, 2020 · 10 revisions

전체 목록 조회

GET /api/milestones
?query{
    isClosed=[true||false]
}
  • response
{
  open,
  closed,
  milestones: [
    { 
      num, 
      title, 
      dueDate, 
      description, 
      openedIssues: 열려있는 이슈의 개수,
      closedIssues: 닫혀있는 이슈의 개수
    },
    ...
  ]
}

추가

POST /api/milestones
  • request data
{ title, dueDate, description }
  • response status code
code 설명
200 정상적으로 생성
400 날짜 형식 오류인 경우
409 레이블 이름이 이미 존재하는 경우
500 내부 서버 에러
  • response
{ 
  success,
  message: 에러시에만 에러 메시지가 응답에 포함됨
}

삭제

DELETE /api/milestones/:num
  • response status code
code 설명
200 정상적으로 삭제
404 삭제를 요청한 번호가 없는 경우
500 내부 서버 에러
  • response
{ 
  success,
  message: 에러시에만 에러 메시지가 응답에 포함됨
}

수정

PATCH /api/milestones/:num
  • request data
{ title, dueDate, description, isClosed }
  • response status code
code 설명
200 정상적으로 수정
400 날짜 형식 오류인 경우
404 수정를 요청한 번호가 없는 경우
500 내부 서버 에러
  • response
{ 
  success,
  message: 에러시에만 에러 메시지가 응답에 포함됨
}

🗂 Project

❗️ Ground Rules

🧩 Trouble Shooting

🗒 API Details

⭐️ Output


🗓 Minutes of meeting
🗓 Daily Scrum
🗓 Peer Session
🗓 Retrospective
Clone this wiki locally