Millstone API

• 전체 Milestone 목록 ⭕️
• 전체 Milestone detail 목록 ⭕️
• 요청된 milestone의 progress ⭕️
• 생성 ⭕️
• 삭제 ⭕️
• 수정 ⭕️

전체 Milestone 목록

Method	Endpoint
GET	/milestones

• responses
  • 성공

    res.status(200).json({
      success: true,
      data: [{
        id: <milestone_id>,
        title: <milstone_title>,
        dueDate: <milstone_dueDate>,
        description: <milstone_description>,
        isOpen: <milstone_isOpen>,
      }, {...}]
    })

  • DB 에러

    res.status(600).json({
      success: false,
      message: "데이터베이스 에러",
    })

  • 서버 내부 에러

    res.status(500).json({
      success: false,
      message: "서버 내부 오류",
    })

전체 Milestone detail 목록

Method	Endpoint
GET	/milestones/detail

• responses
  • 성공

    res.status(200).json({
      success: true,
      data: [{
        id: <milestone_id>,
        title: <milstone_title>,
        dueDate: <milstone_dueDate>,
        description: <milstone_description>,
        isOpen: <milstone_isOpen>,
        openIssue: <count(issue)>,
        closeIssue: <count(issue)> 
      }, {...}]
    })

  • DB 에러

    res.status(600).json({
      success: false,
      message: "데이터베이스 에러",
    })

  • 서버 내부 에러

    res.status(500).json({
      success: false,
      message: "서버 내부 오류",
    })

요청된 milestone의 progress

Method	Endpoint
GET	/milestones/:id

• responses
  • 성공

    res.status(200).json({
      success: true,
      data: {
        id: <milestone_id>,
        title: <milstone_title>,
        dueDate: <milstone_dueDate>,
        description: <milstone_description>,
        isOpen: <milstone_isOpen>,
        openIssue: <count(issue)>,
        closeIssue: <count(issue)> 
      }
    })

  • 잘못된 요청
    • 파라미터가 잘못왔을 때

    res.status(400).json({
      success: false,
      message: "파라미터 값이 잘못 되었습니다.",
    })

  • DB 에러

    res.status(600).json({
      success: false,
      message: "데이터베이스 에러",
    })

  • 서버 내부 에러

    res.status(500).json({
      success: false,
      message: "서버 내부 오류",
    })

생성

Method	Endpoint
POST	/milestones

• body

  {
      title: String,
      dueDate: Date,
      description: String
  }

• responses

  • 성공

    res.status(201).json({
      success: true,
    })

  • 잘못된 요청
    • 파라미터가 안오거나 잘못왔을 때

    res.status(400).json({
      success: false,
      message: "파라미터 값이 잘못 되었습니다.",
    })

  • DB 에러

    res.status(600).json({
      success: false,
      message: "데이터베이스 에러",
    })

  • 서버 내부 에러

    res.status(500).json({
      success: false,
      message: "서버 내부 오류",
    })

삭제

Method	Endpoint
DELETE	/milestones/:id

• responses
  • 성공

    res.status(200).json({
      success: true
    })

  • 잘못된 요청
    • 파라미터가 안오거나 잘못왔을 때

    res.status(400).json({
      success: false,
      message: "파라미터 값이 잘못 되었습니다.",
    })

  • DB 에러

    res.status(600).json({
      success: false,
      message: "데이터베이스 에러",
    })

  • 서버 내부 에러

    res.status(500).json({
      success: false,
      message: "서버 내부 오류",
    })

수정

Method	Endpoint
PATCH	/milestones/:id

• body

  {
      title?: String,
      dueDate?: Date,
      description?: String
  }

• responses

  • 성공

    res.status(200).json({
      success: true
    })

  • 잘못된 요청
    • 파라미터가 안오거나 잘못왔을 때

    res.status(400).json({
      success: false,
      message: "파라미터 값이 잘못 되었습니다.",
    })

  • DB 에러

    res.status(600).json({
      success: false,
      message: "데이터베이스 에러",
    })

  • 서버 내부 에러

    res.status(500).json({
      success: false,
      message: "서버 내부 오류",
    })