230718 API 명세 수정 (11:30 ~ 12:20)

[Cyma-s]

회의 안건

• 공유 API 추가
• 기존 API 명세 수정

예상 시간

• 1시간

[Cyma-s]

추후 이야기할 것들

• 같은 득표수의 킬링파트가 3개 이상일 때
• Response exists 제거

[splitCoding]

파트 등록

• METHOD : POST
• URL : /songs/{song_id}/parts

Request

{
  "startSecond": 5, //시작 초
  "length": 10 //파트 길이 ( 5, 10, 15 )
}

Response

{
  "rank": 3, //파트 순위
  "partUrl": "https://www.youtube.com/embed/{videoId}?start=5&end=15" // 파트 구간 실행가능 URL
}

---

노래 정보 조회 ( 파트 등록 전 )

• METHOD : GET
• URL :  /songs/{song_id}

Request

Response

{
  "id": 3,
  "title": "노래 제목",
  "singer": "가수 이름",
  "videoLength": 180,
  "videoUrl": "https://www.youtube.com/{videoId}",
  "killingParts": []
}

---

노래 정보 조회 ( 파트 등록 후 )

• METHOD : GET
• URL :  /songs/{song_id}

Request

Response

{
  "id": 3,
  "title": "노래 제목",
  "singer": "가수 이름",
  "videoLength": 180,
  "videoUrl": "https://www.youtube.com/{videoId}",
  "killingParts": [
    {
      "exist": true,
      "rank": 1,
      "voteCount": 3,
      "start": 5,
      "end": 15,
      "videoUrl": "https://www.youtube.com/embed/{videoId}?start=5&end=15"
    },
    {
      "exist": true,
      "rank": 2,
      "voteCount": 2,
      "start": 6,
      "end": 16,
      "videoUrl": "https://www.youtube.com/embed/{videoId}?start=6&end=16"
    },
    {
      "exist": true,
      "rank": 3,
      "voteCount": 1,
      "start": 7,
      "end": 17,
      "videoUrl": "https://www.youtube.com/embed/{videoId}?start=7&end=17"
    }
  ]
}

추가 고려 사항

TOP3의 킬링파트를 어떤 기준으로 산정할지

• 같은 득표수의 킬링파트가 3개 이상일 때

---