전체 랭킹 리스트 조회 API Spec

[korea8378]

전체 랭킹 리스트 조회 API Spec

description

• 요청 헤더
  • UID(FireBase에서 관리하는 회원 아이디) - 필수
• 쿼리 파라미터
  • 카테고리 타입 - TOTAL, SOARING (두개만 입력 해주세요)
  • 페이징 인덱스 - 0부터 시작입니다.

    Request

HTTP Method	URI
GET	/v1/rankings

• Header

Name	Value	Description
Accept	application/json	Accept contents
uid	{uid}	Firebase UserId

• parameter

Name	Type	Description
filter	String	TOTAL or SOARING
page	integer	start index - 0

• example

  http://localhost:8080/v1/rankings?filter={filterType}&page={pageIndex}

---

Response

Success

• Status: 200
• Header

Name	Value	Description
Content-Type	application/json

{
  "currentPage": 1,
  "nextPage": 2,
  "totalPage": 54,
  "createAt": "2019-07-11T05:20:11",
  "filterType": "ranking",
  "rankings": [
    {
      "id": 5645,
      "name": "Toy Festival",
      "ranking": 51,
      "viewCount": "9억",
      "subscriberCount": "286만",
      "thumbnail": "https://yt3.ggpht.com/a/AGF-l792-3URJwkQAihd4XLI5ulqGgEA2roRt0-oDA=s800-mo-c-c0xffffffff-rj-k-no",
      "bannerImgUrl": "https://yt3.ggpht.com/Wh7YL0cGPg1SJC2RgXk2ksxeshIRx0HuJdiPGo4UdiAPUqMEFDSTxoWmtoTJgvEHMHwpk5pU=w1920-fcrop64=1,00000000ffffffff-k-c0xffffffff-no-nd-rj"
    },
    {
      "id": 5646,
      "name": "MBCdrama",
      "ranking": 52,
      "viewCount": "29억",
      "subscriberCount": "282만",
      "thumbnail": "https://yt3.ggpht.com/a/AGF-l7_iEBU8PavZX0FodpsJOmz0GyqAQR_YEraqfA=s800-mo-c-c0xffffffff-rj-k-no",
      "bannerImgUrl": "https://yt3.ggpht.com/7qVNki-3TH4svPCcNEJ2XuiyiVlBG0sHbmIiJHvGXPcJ3hWa58CI0t4lvkJjJXXy8MCFk00KGA=w1920-fcrop64=1,00000000ffffffff-nd-c0xffffffff-rj-k-no"
    },
    {
      "id": 5647,
      "name": "SBS NOW",
      "ranking": 53,
      "viewCount": "27억",
      "subscriberCount": "281만",
      "thumbnail": "https://yt3.ggpht.com/a/AGF-l783lbbYfRV4feaKvHYEYmBQl5cJA6DSv6raPQ=s800-mo-c-c0xffffffff-rj-k-no",
      "bannerImgUrl": "https://yt3.ggpht.com/nLrToOg33ey7SYK2Ysfmstti-Hli2_b3VBNl3AeGya9cOFxwclK6QDZ6bGkvbkk915qUiPaeMQ=w1920-fcrop64=1,00000000ffffffff-nd-c0xffffffff-rj-k-no"
    },
    {
      "id": 5648,
      "name": "SBS KPOP PLAY",
      "ranking": 54,
      "viewCount": "14억",
      "subscriberCount": "280만",
      "thumbnail": "https://yt3.ggpht.com/a/AGF-l79CDY5Estq-ri66vAsYLZlbXsic5HDRhfVzBQ=s800-mo-c-c0xffffffff-rj-k-no",
      "bannerImgUrl": "https://yt3.ggpht.com/WqkJSmEfnCXBvr5V4BCh71iL9QQGtxrPRNrjkzW7bUvAyh1HImfXH7SyJpdNrrj8dPVi3oKL-ho=w1920-fcrop64=1,00000000ffffffff-nd-c0xffffffff-rj-k-no"
    },
 ...
  ]
}

Fail

Status	Description
400 Bad Request	존재 하지 않는 카테고리
403 Forbidden	인증 실패
500 Internal Server Error	unknown server error

400 Bad Request

• Status: 400
• Header

Name	Value	Description
Content-Type	application/json

// Not Found Category
{
  "error": {
    "code": 4001,
    "massage": "Not Found Category - Invalid CategoryId"
  }
}

403 FORBIDDEN

• Status: 403
• Header

Name	Value	Description
Content-Type	application/json

// Fail Authentication
{
  "error": {
    "code": 4301,
    "massage": "Fail Authentication - Invalid Uid"
  }
}

---

relate to issue

• 전체 랭킹 리스트 조회(#51)

Check List

• [x] issue 제목은 유의미한가?
• [x] issue 내용은 issue 내용만 확인하고도 모르는 사람도 파악할 수 있을 정도로 기술되었는가? (무엇을, 언제, 어디서...)
• [ ] reference가 있다면 추가했는가?
• [x] 관련 issue가 있다면 추가했는가?
• [x] 유의미한 Label을 추가했는가?
• [x] Assginees를 추가했는가?
• [ ] Estimate를 추가했는가?
• [ ] 관련 Milestone이 있다면 추가했는가?
• [ ] 관련 Epics가 있다면 추가했는가?

[korea8378]

사용하지 않는 API로 close하겠습니다.