Home API
2020.05.09 API spec 회의
홈 화면에서 요청할 API spec에 대해 다루는 문서
Home 화면에 진입 시 요청할 API 목록
- Home API : 홈 화면 진입 시 화면 구성 순서를 요청하는 API
- VideoList API 모음 : 홈 화면의 각 구좌별 Video List를 요청하는 API 모음.
- ChannelList API : 홈 화면의 각 구좌별 Channel List를 요청하는 API 모음
Home 화면에서 사용자 인터렉션으로 인해 요청이 필요한 API 목록
- Tag API : 홈 화면을 구성하는 태그 구좌의 필터 변경을 요청하는 API
(가제)
서비스 앱의 홈 화면을 구성하는 각 구좌의 노출 순서를 받아온다.
서비스 앱 구동 시 가장 먼저 호출한 뒤, 이후 각 구좌별로 영상을 요청한다.
Home 화면을 구성하는 구좌들은 1차 스펙 기준으로 다음과 같다.
| name | rowType |
|---|---|
| 인기 영상 | HotVideo |
| 추천 영상 |
|
| 인기 채널 | HotChannel |
| 최근 영상 | RecentlyVideo |
| 태그 기반 영상 | TagBasedVideo |
// TBD
GET /home
// TBD
// TBD
none
// TBD
// TBD
앞서 논의된 rowType 순서를 전달.
index 붙여서 줄것인가?
개발하면서 편한 방향으로.
// TBD
(가제)
홈 화면 및 랭킹/검색화면 등에서, Video List를 가져오는 API들의 집합
홈 화면에서는 각 구좌별로 이 API들을 요청하여 Video List를 받아온다.
여기에 명시된 API url은 각 용도별로 모두 다르지만, response는 일관성 있게 내려주도록 함.
- ViewType
- Video List
우선 본 section에서 한번에 다루고, 상세 스펙은 추후 분리하여 별도 문서로 작성.
| name | type |
|---|---|
| 인기 영상 | HotVideo |
| 추천 영상 |
|
| 최근 영상 | RecentlyVideo |
| 태그 기반 영상 | TagBasedVideo |
// TBD
GET /hotvideo
GET /recommendedvideo
GET /recentvideo
GET /tagbasedvideo
- 로그인 시 로그인한 사용자 기반의 태그 영상 리스트
- 미로그인 시 로컬 단말에 설정된 태그 영상 리스트
// TBD
// TBD
none
// TBD
// TBD
요청한 영상 리스트와,
노출할 리스트의 ViewType을 내려준다.
(Todo : ViewType 스펙 협의 필요)
// TBD
홈 화면 및 랭킹/검색화면 등에서, Channel List를 가져오는 API들의 집합
현재 홈 화면의 인기 채널 구좌에서만 사용 논의됨.
// TBD
GET /channels
// TBD
// TBD
none
// TBD
// TBD
// TBD
사용자가 홈 화면 영역의 태그 필터를 수정한 경우 호출하는 API
로그인한 상태에서만 요청.
// TBD
GET /tag
// TBD
// TBD
none
// TBD
// TBD
// TBD