Skip to content

API 명세

강병민 (Byungmin Kang) edited this page Nov 25, 2020 · 1 revision

api 쿼리

iOS와 Web에서 사용하는 API가 대략 비슷하나 가져오는 숫자가 다르다. REST한 API를 만들기 위해 QueryString을 사용하기로 결정했다. filter에 해당하는 쿼리가 하나더라도 나중에 추가될 것을 대비해 일단은 default가 없더라도 해당하는 하나의 쿼리를 넣어두겠다.

  1. /api/tracks/?filter=A&limit=B

    • A:
      • recent(최근)
    • B:
      • 숫자(불러오는 개수)
  2. /api/magazines/?filter=A&limit=B

    • A:
      • all, special, pick, genre (magazineType을 filter로)
    • B:
      • 숫자(불러오는 개수)
  3. /api/playlists/?filter=A&limit=B

    • A:
      • VIBE(우리가 만든 플레이리스트 반환)
    • B:
      • 숫자(불러오는 개수)
  4. /api/albums/?filter=A&limit=B

    • A:
      • 없음
    • B:
      • 숫자(불러오는 개수)
  5. /api/dj-stations/?filter=A&limit=B

    • A:
      • 없음
    • B:
      • 숫자(불러오는 개수)

Today에 사용할 API

WEB

- /api/tracks/?filter=recent&limit=10
- /api/magazines/?filter=all&limit=10
- /api/news
- /api/playlists/?filter=VIBE&limit=10
- /api/library/playlists/?limit=10

iOS

- /api/tracks/?filter=A&limit=20
- /api/magazines/?filter=A&limit=5
- /api/playlists/?filter=A&limit= 10
- /api/library/playlists/?limit=4
- /api/dj-stations/?filter=A&limit=12
Clone this wiki locally