개발된 API 명세 Docs

작업 도중에 학습 한 내용 / 공유 할만한 내용들을 공유 하는것을 원칙으로 진행합니다.

해결하고자 하는 주제에 대해 설명 해 주세요.

현재 ( 2020-11-01 ) 개발된 API에 대한 명세가 없는데 해당 이슈를 통해 API에 대한 내용을 정리하고자 합니다.

위 주제를 해결할 수 있는 방안으로는 어떤 것이 있나요?

Swagger UI를 도입 할 수 있습니다. 현재 ( 2020-11-01 ) Local / Test 서버에는 drf-yasg를 활용하여 swagger ui를 도입 한 상태입니다.

어떤 이슈와 연관성이 있나요?

대부분의 이슈와 연관성이 있을 수 있으나, #8 #13 과 연관성이 깊습니다.

다음 작업들이 진행되어야 합니다.

[x] Swagger UI 도입
[x] channels에 대한 정리
[x] devices에 대한 정리
[x] foods에 대한 정리
[x] logs에 대한 정리
[x] restaurants에 대한 정리
[x] users에 대한 정리
[x] videos에 대한 정리
[x] 각종 API들의 input / output 정리

참고 사항

없습니다.

Caution !

29 의 형태로 리턴됩니다. 반드시 해당 이슈를 확인 해주세요.
아래에 적힌 리턴 형태는, #29 의 result에 해당하는 모습입니다.

Common

API Description

item에 대한 url을 통해 api 작업을 진행합니다.
item에 대한 url ( URL )의 GET을 통해 해당 아이템의 list를 받을 수 있고, POST를 통해 해당 아이템을 생성 할 수 있습니다.
item에 대한 url/pk ( Detail URL ) 에서는 pk에 해당하는 아이템에 대한 정보를 다룰 수 있으며, 허용하는 메소드에 따라 행동을 달리 할 수 있습니다.
paging의 단위는 30으로 구현하였습니다. ( 수정 필요할 시 comment 부탁드립니다. )
API Request / Response
해당 API에 대한 Request / Response에 대해 redoc / swagger에 나와 있는것 이외의 정보가 필요 한 경우 해당 경우를 서술합니다.
해당 API에 대한 Request / Response에 대해 redoc / swagger에 나와 있는것 이외의 정보가 필요 하지 않은 경우 따로 Request / Response에 대해 서술하지 않습니다.

Channels

API Info

유튜브 채널에 대한 정보를 담고 있습니다.
URL scheme

url : /api/v1/channels/
GET
- DB에 등록된 모든 채널들에 대한 정보를 리턴합니다.
- DB에 등록된 모든 채널들에 대한 정보가 필요 할 때 사용 할 수 있습니다.
- 누구든지 해당 정보에 접근 할 수 있습니다. ( permission : AllowAny )
- Request / Response 에 대해서는 Redoc의 채널 항목을 참고 하시면 됩니다.
POST
- 유튜브 채널 데이터를 생성합니다.
- 유튜버가 우리 서비스를 이용하기 위해 회원가입 및 승인 신청을 하는 경우에 사용 될 수 있습니다.
- 참고 : Request params 설명 : https://github.com/TeamPomPom/MukMap-Server/issues/25#issuecomment-728971923
- 로그인 한 유저만 접근 할 수 있습니다 ( permission : IsAuthenticated )
- Request / Response 에 대해서는 Redoc의 채널 항목을 참고 하시면 됩니다.
  url : /api/v1/channels/pk_num
GET
- channel의 id값이 pk_num인 채널에 대한 정보를 리턴합니다.
- 누구든지 해당 정보에 접근 할 수 있습니다. ( permission : AllowAny )
- Request에 대해서는 Redoc의 restaurant 항목 / https://github.com/TeamPomPom/MukMap-Server/issues/17#issuecomment-723396212 을 참고 하시면 됩니다.
- Response에 대해서는 Redoc과 다르게 동작합니다.
  - Request : /api/v1/channels/1/
  - Response 예시입니다. 실제 결과는 클라이언트 호출 후 확인 부탁 드립니다.
  { "id": 1, "province_stat": [ { "province": "서울", "province_ratio": "81.16" }, { "province": "부산", "province_ratio": "7.25" }, { "province": "전북", "province_ratio": "5.80" } ], "main_food_stat": [ { "main_food_category": "일식", "main_food_category_ratio": "57.48" }, { "main_food_category": "양식", "main_food_category_ratio": "16.54" }, { "main_food_category": "한식", "main_food_category_ratio": "13.39" } ], "deleted": null, "created": "2020-10-18T12:12:42.930315Z", "updated": "2020-10-18T12:12:42.930461Z", "channel_name": "monster gourmet", "channel_thumbnail": "{'default': {'url': 'https://yt3.ggpht.com/a/AATXAJxJi9ElzZlJXgt9dsS_eUNcvi1t_EO-z4yug2vbYr0=s88-c-k-c0xffffffff-no-rj-mo', 'width': 88, 'height': 88}, 'medium': {'url': 'https://yt3.ggpht.com/a/AATXAJxJi9ElzZlJXgt9dsS_eUNcvi1t_EO-z4yug2vbYr0=s240-c-k-c0xffffffff-no-rj-mo', 'width': 240, 'height': 240}, 'high': {'url': 'https://yt3.ggpht.com/a/AATXAJxJi9ElzZlJXgt9dsS_eUNcvi1t_EO-z4yug2vbYr0=s800-c-k-c0xffffffff-no-rj-mo', 'width': 800, 'height': 800}}", "channel_id": "UCngw6cNCHiqRxv7wmLayH1w", "channel_desc": "born to eat. especially sushi.", "channel_country": "KR", "channel_keyword": "먹방 맛집 초밥 스시 오마카세 sushi mukbang \"food porn\" omakase yummy 美味しいすしおまかせ" }
DELETE
- channel의 데이터를 삭제 합니다.
- 요청한 유저가, 해당 채널의 주인이며, 해당 채널에 연결된 비디오가 없는 경우에만 접근 할 수 있습니다. ( permission : channels.permissions.IsOwner, channnels.permissions.HasEmptyVideo )
- Request / Response 에 대해서는 Redoc의 채널 항목을 참고 하시면 됩니다.
Other ( put / patch )
- channel의 데이터를 수정 합니다.
- 유튜버가 자신의 정보를 수정 / 삭제 할 때 사용 할 수 있습니다.
- 요청한 유저가, 해당 채널의 주인인 경우에만 접근 할 수 있습니다. ( permission : channels.permissions.IsOwner )
- Request / Response 에 대해서는 Redoc의 채널 항목을 참고 하시면 됩니다.

Restaurants

API Info

음식점에 대한 정보를 담고 있습니다.
URL scheme

url : /api/v1/restaurants/
GET
- DB에 등록된 모든 음식점들에 대한 정보를 리턴합니다.
- DB에 등록된 모든 음식점들에 대한 정보가 필요 할 때 사용 할 수 있습니다.
- 누구든지 해당 정보에 접근 할 수 있습니다. ( permission : AllowAny )
- Request / Response에 대해서는 Redoc의 restaurant 항목을 참고 하시면 됩니다.
POST
- 음식점 데이터를 생성합니다.
- 회원가입 승인 된 유튜브 채널 유저가, 웹에서 영상에 대한 정보를 등록 할 때 DB에 없는 음식점에 방문 시 사용 될 수 있습니다.
- 회원가입 승인 된 유튜브 채널 유저만 접근 할 수 있습니다. ( permission : restaurants.permissions.IsApprovedChannel )
- Request / Response에 대해서는 Redoc의 restaurant 항목을 참고 하시면 됩니다.
  url : /api/v1/restaurants/pk_num
GET
- restaurant의 id값이 pk_num인 음식점 대한 정보를 리턴합니다.
- 해당 정보엔 tag값이 존재합니다
- 누구든지 해당 정보에 접근 할 수 있습니다. ( permission : AllowAny )
- Request에 대해서는 Redoc의 restaurant 항목을 참고 하시면 됩니다.
- Response에 대해서는 Redoc과 다르게 동작합니다.
  - Request : /api/v1/restaurants/1/
  - Response 예시입니다. 실제 결과는 클라이언트 호출 후 확인 부탁 드립니다.
```
{
 "id": 1,
 "tags": [
   "회",
   "호텔뷔페",
   "삼겹살",
   "잡채"
 ],
 "deleted": null,
 "created": "2020-10-18T11:26:26.495039Z",
 "updated": "2020-11-13T16:36:08.796735Z",
 "name": "정화순대",
 "lat": "34.8453686",
 "lng": "128.4241448",
 "full_address": "경남 통영시 중앙로 152-9",
 "province": "경남",
 "district": "통영시",
 "old_district": "중앙동",
 "subway": []
}
```
Other ( put / patch / delete )
- restaurant의 데이터를 수정 / 삭제 합니다.
- Admin user가 레스토랑이 폐업한 것을 확인 한다거나, 정보의 수정이 필요 할 때 사용 할 수 있습니다.
- Admin user만 접근 할 수 있습니다. ( permission : IsAdminUser )
- Request / Response에 대해서는 Redoc의 restaurant 항목을 참고 하시면 됩니다.

url : /api/v1/restaurants/geo_search/

GET 메소드만 허용합니다.
위경도 값으로 음식점을 조회할 때 사용 될 수 있습니다.
위경도 값을 받으면, 해당 위치에서 반경 2km 내의 음식점 정보를 리턴합니다. ( 계산 방식 : haversine 참조 : https://pypi.org/project/haversine/ ,https://en.wikipedia.org/wiki/Haversine_formula )
해당 음식점 정보에 포함되어있는 채널 정보는, 해당 음식점에 최근에 갔다 온 순서로 되어 있습니다.
로그인 상태라면, is_subscribe필드를 통해 해당 음식점 정보에 포함되어있는 채널을 유저가 구독 중인지, 아닌지 상태를 확인 할 수 있습니다.
누구든지 해당 정보에 접근 할 수 있습니다. ( permission : AllowAny )

Request / Response에 대해서 Redoc과 다르게 동작합니다.

Request
- lat, lng 값이 반드시 필요합니다.
- page 값이 필요합니다. page값은 없다면 1페이지에 대한 정보를 리턴합니다.
- 해당 데이터는 float형식으로 받습니다.
- 해당 데이터 없이 요청시 400 에러를 리턴합니다.

Response 예시입니다. 실제 결과는 클라이언트 호출 후 확인 부탁 드립니다.

Request : /api/v1/restaurants/geo_search/?lat=34.8453686&lng=128.424144

"restaurants":[
{
"id":1,
"name":"정화순대",
"lat":"34.8453686",
"lng":"128.4241448",
"full_address":"경남 통영시 중앙로 152-9",
"youtube_channel":[
   {
      "channel_id":32,
      "channel_name":"asdfasdfChannelName",
      "channel_thumbnail":"",
      "is_subscribe":false
   },
   {
      "channel_id":16,
      "channel_name":"츄릅켠",
      "channel_thumbnail":"{'default': {'url': 'https://yt3.ggpht.com/a/AATXAJz-uEtev4GcQeHmcHnmBXnTVM3jNYVFbcEPZ5Nn=s88-c-k-c0xffffffff-no-rj-mo', 'width': 88, 'height': 88}, 'medium': {'url': 'https://yt3.ggpht.com/a/AATXAJz-uEtev4GcQeHmcHnmBXnTVM3jNYVFbcEPZ5Nn=s240-c-k-c0xffffffff-no-rj-mo', 'width': 240, 'height': 240}, 'high': {'url': 'https://yt3.ggpht.com/a/AATXAJz-uEtev4GcQeHmcHnmBXnTVM3jNYVFbcEPZ5Nn=s800-c-k-c0xffffffff-no-rj-mo', 'width': 800, 'height': 800}}",
      "is_subscribe":true
   }
],
"is_favorite":false
},
{
"id":444,
"name":"비치실비",
"lat":"34.8415431",
"lng":"128.4185553",
"full_address":"경남 통영시 중앙로 84",
"youtube_channel":[
   {
      "channel_id":13,
      "channel_name":"섬마을훈태TV",
      "channel_thumbnail":"{'default': {'url': 'https://yt3.ggpht.com/a/AATXAJxZPFfUiW15DSObK5tnUJBfuUAVHbpPxoA43mj2nw=s88-c-k-c0xffffffff-no-rj-mo', 'width': 88, 'height': 88}, 'medium': {'url': 'https://yt3.ggpht.com/a/AATXAJxZPFfUiW15DSObK5tnUJBfuUAVHbpPxoA43mj2nw=s240-c-k-c0xffffffff-no-rj-mo', 'width': 240, 'height': 240}, 'high': {'url': 'https://yt3.ggpht.com/a/AATXAJxZPFfUiW15DSObK5tnUJBfuUAVHbpPxoA43mj2nw=s800-c-k-c0xffffffff-no-rj-mo', 'width': 800, 'height': 800}}",
      "is_subscribe":false
   }
],
"is_favorite":false
},
...
]

url : /api/v1/restaurants/query_search/

GET 메소드만 허용합니다.
쿼리문으로 음식점을 조회할 때 사용 될 수 있습니다.
쿼리 데이터를 기반으로 검색하며, 쿼리 데이터를 띄워쓰기로 단어를 분리하여 검색에 사용합니다.
위에서 분리한 단어들의 각 단어가 음식에 관련된 단어인지, 위치에 관련된 단어인지, 채널에 관련된 단어인지, 지하철 역에 대한 단어인지 추출 하여 device token과 함께 search log 테이블에 저장합니다.
유저가 검색한 쿼리에 관련된 채널이 있다면 관련된 채널 중 가장 관련성이 높은 채널 정보를 함께 리턴합니다.
누구든지 해당 정보에 접근 할 수 있습니다. ( permission : AllowAny )

Request / Response에 대해서 Redoc과 다르게 동작합니다.

Request
- query, device_token, page 값이 필요합니다. page값은 없다면 1페이지에 대한 정보를 리턴합니다.
- query 데이터는 String 형식으로 받습니다.
- device_token 데이터는 String 형식으로 받습니다.
- page 데이터는 int 형식으로 받습니다.
- query나 device_token이 없이 요청시 400 에러를 리턴합니다.

Response

Response 예시입니다. 실제 결과는 클라이언트 호출 후 확인 부탁 드립니다.

Request : /api/v1/restaurants/query_search/?query=해운대 사먹사전&device_token=somethingToken

{
"restaurants": [
{
  "id": 1114,
  "name": "포차 용산스타일",
  "lat": "37.5342543",
  "lng": "126.9624550",
  "full_address": "서울 용산구 새창로 149",
  "youtube_channel": [],
  "is_favorite": false
},
{
  "id": 1125,
  "name": "닭한마리 공릉본점",
  "lat": "37.6211445",
  "lng": "127.0747999",
  "full_address": "서울 노원구 동일로 1020",
  "youtube_channel": [
    {
      "channel_id": 14,
      "channel_name": "우니의끼니 UNIII",
      "channel_thumbnail": "{'default': {'url': 'https://yt3.ggpht.com/a/AATXAJxo1q0zgm4bzhuQEr5nYTrW4SOm-lIYjIM9y0q6=s88-c-k-c0xffffffff-no-rj-mo', 'width': 88, 'height': 88}, 'medium': {'url': 'https://yt3.ggpht.com/a/AATXAJxo1q0zgm4bzhuQEr5nYTrW4SOm-lIYjIM9y0q6=s240-c-k-c0xffffffff-no-rj-mo', 'width': 240, 'height': 240}, 'high': {'url': 'https://yt3.ggpht.com/a/AATXAJxo1q0zgm4bzhuQEr5nYTrW4SOm-lIYjIM9y0q6=s800-c-k-c0xffffffff-no-rj-mo', 'width': 800, 'height': 800}}",
      "is_subscribe": false
    }
  ],
  "is_favorite": false
},
{
  "id": 1144,
  "name": "카페온화 익선점",
  "lat": "37.5732771",
  "lng": "126.9898574",
  "full_address": "서울 종로구 수표로28길 21-10",
  "youtube_channel": [
    {
      "channel_id": 14,
      "channel_name": "우니의끼니 UNIII",
      "channel_thumbnail": "{'default': {'url': 'https://yt3.ggpht.com/a/AATXAJxo1q0zgm4bzhuQEr5nYTrW4SOm-lIYjIM9y0q6=s88-c-k-c0xffffffff-no-rj-mo', 'width': 88, 'height': 88}, 'medium': {'url': 'https://yt3.ggpht.com/a/AATXAJxo1q0zgm4bzhuQEr5nYTrW4SOm-lIYjIM9y0q6=s240-c-k-c0xffffffff-no-rj-mo', 'width': 240, 'height': 240}, 'high': {'url': 'https://yt3.ggpht.com/a/AATXAJxo1q0zgm4bzhuQEr5nYTrW4SOm-lIYjIM9y0q6=s800-c-k-c0xffffffff-no-rj-mo', 'width': 800, 'height': 800}}",
      "is_subscribe": false
    }
  ],
  "is_favorite": false
},
{
  "id": 1154,
  "name": "옹골찬아구동태해물찜탕 본점",
  "lat": "37.5792090",
  "lng": "127.0872519",
  "full_address": "서울 중랑구 면목로 302 ktf",
  "youtube_channel": [
    {
      "channel_id": 14,
      "channel_name": "우니의끼니 UNIII",
      "channel_thumbnail": "{'default': {'url': 'https://yt3.ggpht.com/a/AATXAJxo1q0zgm4bzhuQEr5nYTrW4SOm-lIYjIM9y0q6=s88-c-k-c0xffffffff-no-rj-mo', 'width': 88, 'height': 88}, 'medium': {'url': 'https://yt3.ggpht.com/a/AATXAJxo1q0zgm4bzhuQEr5nYTrW4SOm-lIYjIM9y0q6=s240-c-k-c0xffffffff-no-rj-mo', 'width': 240, 'height': 240}, 'high': {'url': 'https://yt3.ggpht.com/a/AATXAJxo1q0zgm4bzhuQEr5nYTrW4SOm-lIYjIM9y0q6=s800-c-k-c0xffffffff-no-rj-mo', 'width': 800, 'height': 800}}",
      "is_subscribe": false
    }
  ],
  "is_favorite": false
},
{
  "id": 1171,
  "name": "뚝떡",
  "lat": "37.5468886",
  "lng": "127.0438746",
  "full_address": "서울 성동구 서울숲4길 28",
  "youtube_channel": [
    {
      "channel_id": 14,
      "channel_name": "우니의끼니 UNIII",
      "channel_thumbnail": "{'default': {'url': 'https://yt3.ggpht.com/a/AATXAJxo1q0zgm4bzhuQEr5nYTrW4SOm-lIYjIM9y0q6=s88-c-k-c0xffffffff-no-rj-mo', 'width': 88, 'height': 88}, 'medium': {'url': 'https://yt3.ggpht.com/a/AATXAJxo1q0zgm4bzhuQEr5nYTrW4SOm-lIYjIM9y0q6=s240-c-k-c0xffffffff-no-rj-mo', 'width': 240, 'height': 240}, 'high': {'url': 'https://yt3.ggpht.com/a/AATXAJxo1q0zgm4bzhuQEr5nYTrW4SOm-lIYjIM9y0q6=s800-c-k-c0xffffffff-no-rj-mo', 'width': 800, 'height': 800}}",
      "is_subscribe": false
    }
  ],
  "is_favorite": false
}
],
"channel": {
"id": 12,
"deleted": null,
"created": "2020-10-18T12:13:07.650845Z",
"updated": "2020-10-18T12:13:07.650898Z",
"channel_name": "사먹사전",
"channel_thumbnail": "{'default': {'url': 'https://yt3.ggpht.com/a/AATXAJwDCHoQIhD7d8qvZoja5iaggH1DigkwbNS-DEDHYA=s88-c-k-c0xffffffff-no-rj-mo', 'width': 88, 'height': 88}, 'medium': {'url': 'https://yt3.ggpht.com/a/AATXAJwDCHoQIhD7d8qvZoja5iaggH1DigkwbNS-DEDHYA=s240-c-k-c0xffffffff-no-rj-mo', 'width': 240, 'height': 240}, 'high': {'url': 'https://yt3.ggpht.com/a/AATXAJwDCHoQIhD7d8qvZoja5iaggH1DigkwbNS-DEDHYA=s800-c-k-c0xffffffff-no-rj-mo', 'width': 800, 'height': 800}}",
"channel_id": "UC0Yp99lFb0j5Bk_uovKHb4g",
"channel_desc": "오래된 식당, 오래된 이야기\n\n때로는 허름하고, 때로는 투박해도\n수 많은 사람들의 추억이 담긴 오래되고 \n소중한 식당을 소개하는 사먹사전입니다.\n\n주로 부산, 가끔 경남, 가아끔 경북\n경상도 곳곳의 식당들을 소개해드립니다!\n\n사먹사전은 “사먹은 음식 백과사전”의 줄임말로\n백과사전처럼 자세히 리뷰해보자는 뜻입니다.\n\n고등학교 동창인 지우준, 길현준이 한 팀을\n이루어 열심히 꾸려나가고 있습니다.\n\n입맛이 달라서 때론 서비스가 달라서 실망을 하실 수도 \n있지만 절대 거짓말은 하지 않는다고 약속드립니다.\n\n영상을 보고 식당을 방문하실 때에는 충분한\n검색을 통해 잘 알아보고 가심을 권해드립니다.\n\n영상 업로드 : 월, 금 17:30\n식당 제보 : kilji051@gmail.com\n비즈니스 문의 : samuksajeon@sandboxnetwork.net",
"channel_country": "KR",
"channel_keyword": "부산여행 부산 사먹사전 노포 식당리뷰"
}
}

url : /api/v1/restaurants/geo_search_app/

GET 메소드만 허용합니다.
위경도 값 및 앱 이름으로 특정 유튜버가 다녀온 음식점만을 조회할 때 사용 될 수 있습니다.
앱 이름과 위경도 값을 받으면, 해당 위치에서 반경 2km 내의 음식점 정보를 리턴합니다. ( 계산 방식 : haversine 참조 : https://pypi.org/project/haversine/ ,https://en.wikipedia.org/wiki/Haversine_formula )
해당 음식점 정보에 포함되어있는 채널 정보는, 해당 음식점에 최근에 갔다 온 순서로 되어 있습니다.
로그인 상태라면, is_subscribe필드를 통해 해당 음식점 정보에 포함되어있는 채널을 유저가 구독 중인지, 아닌지 상태를 확인 할 수 있습니다.
누구든지 해당 정보에 접근 할 수 있습니다. ( permission : AllowAny )

Request / Response에 대해서 Redoc과 다르게 동작합니다.

Request
- lat, lng,app_name 값이 반드시 필요합니다.
- page 값이 필요합니다. page값은 없다면 1페이지에 대한 정보를 리턴합니다.
- 해당 데이터는 float형식으로 받습니다.
- 해당 데이터 없이 요청시 400 에러를 리턴합니다.

Response 예시입니다. 실제 결과는 클라이언트 호출 후 확인 부탁 드립니다.

Request : /api/v1/restaurants/geo_search_app/?lat=34.8453686&lng=128.424144&app_name=FoodieLand

"restaurants": [
{
    "id": 444,
    "name": "비치실비",
    "lat": "34.8415431",
    "lng": "128.4185553",
    "full_address": "경남 통영시 중앙로 84",
    "youtube_channel": [
        {
            "channel_id": 13,
            "channel_name": "섬마을훈태TV",
            "channel_thumbnail": "{'default': {'url': 'https://yt3.ggpht.com/a/AATXAJxZPFfUiW15DSObK5tnUJBfuUAVHbpPxoA43mj2nw=s88-c-k-c0xffffffff-no-rj-mo', 'width': 88, 'height': 88}, 'medium': {'url': 'https://yt3.ggpht.com/a/AATXAJxZPFfUiW15DSObK5tnUJBfuUAVHbpPxoA43mj2nw=s240-c-k-c0xffffffff-no-rj-mo', 'width': 240, 'height': 240}, 'high': {'url': 'https://yt3.ggpht.com/a/AATXAJxZPFfUiW15DSObK5tnUJBfuUAVHbpPxoA43mj2nw=s800-c-k-c0xffffffff-no-rj-mo', 'width': 800, 'height': 800}}",
            "is_subscribe": false
        }
    ],
    "is_favorite": false
},
{
    "id": 461,
    "name": "술독에빠진사람들",
    "lat": "34.8421850",
    "lng": "128.4240268",
    "full_address": "경남 통영시 장좌로 42 성진산업",
    "youtube_channel": [
        {
            "channel_id": 13,
            "channel_name": "섬마을훈태TV",
            "channel_thumbnail": "{'default': {'url': 'https://yt3.ggpht.com/a/AATXAJxZPFfUiW15DSObK5tnUJBfuUAVHbpPxoA43mj2nw=s88-c-k-c0xffffffff-no-rj-mo', 'width': 88, 'height': 88}, 'medium': {'url': 'https://yt3.ggpht.com/a/AATXAJxZPFfUiW15DSObK5tnUJBfuUAVHbpPxoA43mj2nw=s240-c-k-c0xffffffff-no-rj-mo', 'width': 240, 'height': 240}, 'high': {'url': 'https://yt3.ggpht.com/a/AATXAJxZPFfUiW15DSObK5tnUJBfuUAVHbpPxoA43mj2nw=s800-c-k-c0xffffffff-no-rj-mo', 'width': 800, 'height': 800}}",
            "is_subscribe": false
        }
    ],
    "is_favorite": false
}
]

url : /api/v1/restaurants/app_restaurants/

GET 메소드만 허용합니다.
특정 앱에서 쓰이는 비디오 / 음식점 데이터만 리턴합니다
앱 이름과, 페이징 크기 / 현재 페이지 정보를 받습니다

누구든지 해당 정보에 접근 할 수 있습니다. ( permission : AllowAny )

Request
- app_name 값이 반드시 필요합니다.
- 해당 데이터 없이 요청시 400 에러를 리턴합니다.
- page 값이 필요합니다. page값은 없다면 1페이지에 대한 정보를 리턴합니다.
- page_size 값이 필요합니다. page_siz값은 없다면 30개의 정보만 리턴합니다.

Response 예시입니다. 실제 결과는 클라이언트 호출 후 확인 부탁 드립니다.

Request : /api/v1/app_restaurants/?app_name=BaekMap&page_size=100

{
"success": true,
"result": {
"restaurants": [
{
    "id": 1675,
    "name": "도산식육식당",
    "lat": "36.1324996",
    "lng": "128.3437233",
    "full_address": "경북 구미시 지산1길 26",
    "youtube_video": {
        "youtube_video_id": "rEhi5E11hT4",
        "youtube_thumbnail": "https://i.ytimg.com/vi/rEhi5E11hT4/maxresdefault.jpg",
        "place_id": "15412853",
        "episode_num": 29,
        "youtube_title": "[백종원의 님아 그 시장을 가오_EP.29_구미] 고기 반 마늘 반! 무조건 밥 한 공기 추가하는 마성의 돼지찌개 먹고 왔습니다!"
    },
    "main_category": "한식",
    "sub_category": [
        "돼지찌개"
    ],
    "province": "경북",
    "district": "구미시",
    "old_district": "지산동"
}
]
},
"message": null
}

Devices

API Info

유저의 기기에 대한 정보를 담고 있습니다.

URL scheme

url : /api/v1/devices/

GET
- DB에 등록된 기기 정보들에 대한 정보를 리턴합니다.
- DB에 등록된 기기 정보들에 대한 정보가 필요 할 때 사용 할 수 있습니다.
- Admin user만 접근 할 수 있습니다. ( permission : IsAdminUser )
- Request / Response 에 대해서는 Redoc의 device 항목을 참고 하시면 됩니다.
POST
- 기기 정보 데이터를 생성합니다.
- 앱을 처음 사용하는 유저가 본인의 device_token을 DB에 등록 할 때, 유저가 로그인을 했을 때 사용합니다.
- device_token변수로 device_token값을 받습니다. 해당 값이 없을시 400 status를 반환합니다.
- 로그인에 성공하면, client는 해당 device_token을 서버에 다시 보내야 합니다.
- user 정보와, device_token을 담아 해당 함수를 호출하면, device_token 정보의 user 값을 현재 로그인 한 유저로 갱신시킵니다.
- 누구든지 해당 정보에 접근 할 수 있습니다. ( permission : AllowAny )
- Request / Response 에 대해서는 Redoc의 device 항목을 참고 하시면 됩니다.
  url : /api/v1/devices/pk_num/
Other ( get / put / patch / delete )
- device의 데이터를 조회 / 수정 / 삭제 합니다.
- 정보의 수정이 필요 할 때 사용 할 수 있습니다.
- Admin user만 접근 할 수 있습니다. ( permission : IsAdminUser )
- Request / Response 에 대해서는 Redoc의 device 항목을 참고 하시면 됩니다.

url : /api/v1/devices/get_device/

GET
- 해당 api는 GET만 허용합니다.
- device token의 값이 Device table에 기록되어 있을 때, Device에 대한 정보를 리턴합니다.
- 이 API는 Header에 Device 값으로 device token 값을 반드시 보내셔야 합니다.
- 누구나 접근 할 수 있습니다. ( permission : AllowAny )
- Request 에 대해서는 Redoc의 device 항목을 참고 하시면 됩니다.
- Response 예시입니다. 실제 결과는 클라이언트 호출 후 확인 부탁 드립니다.
- Request : /api/v1/devices/get_device/
```
{
   "success": true,
   "result": {
       "id": 5,
       "deleted": null,
       "created": "2022-04-19T15:20:36.125164Z",
       "updated": "2022-04-19T15:20:36.125220Z",
       "device_token": "hahahafirstTokenknono",
       "user": null,
       "favorite": [],
       "subscribe": []
   },
   "message": null
}
```

url : /api/v1/devices/pk_num/search/

GET

해당 api는 GET만 허용합니다.
device의 id값이 pk_num인 기기가, 검색했던 검색 로그들에 대한 정보를 리턴합니다.
웹에서 특정 디바이스의 검색 로그를 확인 하는데 사용 할 수 있습니다.
Admin user만 접근 할 수 있습니다. ( permission : IsAdminUser )
Request 에 대해서는 Redoc의 device 항목을 참고 하시면 됩니다.
Response 예시입니다. 실제 결과는 클라이언트 호출 후 확인 부탁 드립니다.

Request : /api/v1/devices/2/search/

[
  {
    "id": 1,
    "deleted": null,
    "created": "2020-11-08T09:57:49.243575Z",
    "updated": "2020-11-08T09:57:49.252172Z",
    "search_keyword": "구의",
    "food_keyword": null,
    "region_keyword": "['구의']",
    "channel_keyword": null,
    "subway_keyword": null,
    "device": 2
  },
  {
    "id": 2,
    "deleted": null,
    "created": "2020-11-08T09:58:12.091602Z",
    "updated": "2020-11-08T09:58:12.099839Z",
    "search_keyword": "잠실",
    "food_keyword": null,
    "region_keyword": "['잠실']",
    "channel_keyword": null,
    "subway_keyword": null,
    "device": 2
  },
  ...
]

url : /api/v1/devices/pk_num/click/

GET
- device의 id값이 pk_num인 기기가, 영상을 클릭했던 클릭 로그들에 대한 정보를 리턴합니다.
- 웹에서 특정 디바이스의 클릭 로그를 확인 하는데 사용 할 수 있습니다.
- Admin user만 접근 할 수 있습니다. ( permission : IsAdminUser )
- Request에 대해서는 Redoc의 devices_click_read 항목을 참고 하시면 됩니다.
- Response 예시입니다. 실제 결과는 클라이언트 호출 후 확인 부탁 드립니다.
- Request : /api/v1/devices/2/click/
```
[
{
"id": 2,
"deleted": null,
"created": "2020-11-18T15:19:31.534217Z",
"updated": "2020-11-18T15:19:31.595776Z",
"device": 2,
"youtube_video": 2
},
{
"id": 3,
"deleted": null,
"created": "2020-11-18T15:19:39.470219Z",
"updated": "2020-11-18T15:19:39.470271Z",
"device": 2,
"youtube_video": 2
}
]
```
POST
- device의 id값이 pk_num인 기기의 클릭 로그 데이터를 생성합니다.
- video_id 변수로 youtube_video 정보의 pk값을 받습니다.
- pk_num, video_id값이 올바르게 주어지지 않는다면, 400 status를 반환합니다.
- 누구든지 해당 정보에 접근 할 수 있습니다. ( permission : AllowAny )
- Request
  - video_id 값이 필요합니다.
  - video_id 값이 없이 요청시 400 에러를 리턴합니다.
- Response
  - Response는 아무런 값 없이 200 http code만을 리턴합니다.

url : /api/v1/devices/pk_num/favorites

GET

pk_num에 해당하는 Device가 좋아하는 영상들에 대한 정보를 리턴합니다.
Request 에 대해서는 Redoc의 devices 항목을 참고 하시면 됩니다.

Response

Request : /api/v1/devices/11/favorites/

Response 예시입니다. 실제 결과는 클라이언트 호출 후 확인 부탁 드립니다.

[
{
"id": 2,
"deleted": null,
"created": "2020-10-18T11:26:26.519060Z",
"updated": "2020-11-13T16:36:08.929830Z",
"name": "시그니엘부산 the view",
"lat": "35.1599209",
"lng": "129.1697564",
"full_address": "부산광역시 해운대구 중동 달맞이길 30 시그니엘부산 5층",
"province": "부산광역시",
"district": "해운대구",
"old_district": "중동",
"subway": [
152
]
}
]

PUT
- pk 값으로 영상의 pk값을 주어야 합니다. 이 값이 없다면 HTTP_400_BAD_REQUEST 에러를 리턴합니다.
- pk_num에 해당하는 유저의 해당 영상에 대한 좋아요 상태를 변경합니다. ( 좋아요 x -> 좋아요 o / 좋아요 o -> 좋아요 x )
- Request
  - restaurant_id 값이 필요합니다.
  - restaurant_id 값이 없으면 400 에러를 리턴합니다.
- Response
  - 성공 시 200 코드를 리턴합니다.
    url : /api/v1/devices/pk_num/subscribes

GET

pk_num에 해당하는 유저가 우리 서비스 속에서 구독한 채널들에 대한 정보를 리턴합니다.
Request 에 대해서는 Redoc의 devices 항목을 참고 하시면 됩니다.

Response

Request : /api/v1/devices/11/subscribes/

Response 예시입니다. 실제 결과는 클라이언트 호출 후 확인 부탁 드립니다.

[
{
"id": 1,
"deleted": null,
"created": "2020-10-18T12:12:42.930315Z",
"updated": "2020-10-18T12:12:42.930461Z",
"channel_name": "monster gourmet",
"channel_thumbnail": "{'default': {'url': 'https://yt3.ggpht.com/a/AATXAJxJi9ElzZlJXgt9dsS_eUNcvi1t_EO-z4yug2vbYr0=s88-c-k-c0xffffffff-no-rj-mo', 'width': 88, 'height': 88}, 'medium': {'url': 'https://yt3.ggpht.com/a/AATXAJxJi9ElzZlJXgt9dsS_eUNcvi1t_EO-z4yug2vbYr0=s240-c-k-c0xffffffff-no-rj-mo', 'width': 240, 'height': 240}, 'high': {'url': 'https://yt3.ggpht.com/a/AATXAJxJi9ElzZlJXgt9dsS_eUNcvi1t_EO-z4yug2vbYr0=s800-c-k-c0xffffffff-no-rj-mo', 'width': 800, 'height': 800}}",
"channel_id": "UCngw6cNCHiqRxv7wmLayH1w",
"channel_desc": "born to eat. especially sushi.",
"channel_country": "KR",
"channel_keyword": "먹방 맛집 초밥 스시 오마카세 sushi mukbang \"food porn\" omakase yummy 美味しい すし おまかせ"
},
{
"id": 16,
"deleted": null,
"created": "2020-10-18T12:13:07.740323Z",
"updated": "2020-10-18T12:13:07.740392Z",
"channel_name": "츄릅켠",
"channel_thumbnail": "{'default': {'url': 'https://yt3.ggpht.com/a/AATXAJz-uEtev4GcQeHmcHnmBXnTVM3jNYVFbcEPZ5Nn=s88-c-k-c0xffffffff-no-rj-mo', 'width': 88, 'height': 88}, 'medium': {'url': 'https://yt3.ggpht.com/a/AATXAJz-uEtev4GcQeHmcHnmBXnTVM3jNYVFbcEPZ5Nn=s240-c-k-c0xffffffff-no-rj-mo', 'width': 240, 'height': 240}, 'high': {'url': 'https://yt3.ggpht.com/a/AATXAJz-uEtev4GcQeHmcHnmBXnTVM3jNYVFbcEPZ5Nn=s800-c-k-c0xffffffff-no-rj-mo', 'width': 800, 'height': 800}}",
"channel_id": "UCqVjsRNWQM-ZBl27Pp8qI5g",
"channel_desc": "부산의 생활외식인 ???? 솔직하고 유쾌하게",
"channel_country": "KR",
"channel_keyword": "None"
}
]

PUT
- pk 값으로 영상의 pk값을 주어야 합니다. 이 값이 없다면 HTTP_400_BAD_REQUEST 에러를 리턴합니다.
- pk_num에 해당하는 유저의 해당 채널에 대한 구독 상태를 변경합니다. ( 구독 x -> 구독 o / 구독 o -> 구독 x )
- Request
  - channel_id 값이 필요합니다.
  - channel_id 값이 없으면 400 에러를 리턴합니다.
- Response
  - 성공 시 200 코드를 리턴합니다.

현재 ( 2020-11-02 ) Logs에 대한 api는 device api에 모두 서술되어 있습니다. 추가적인 api가 필요하다고 생각되면 코멘트 부탁드립니다.

Foods

API Info

음식 카테고리에 대한 정보를 담고 있습니다.
Request / Response 에 대해서는 Redoc의 Foods 항목을 참고 하시면 됩니다.
URL scheme

url : /api/v1/foods/main
GET
- DB에 등록된 음식 대분류에 대한 정보를 리턴합니다.
- 유튜버가 웹에서 영상을 등록 할 때, 음식 대분류를 선택 할 때 사용 될 수 있습니다.
- 회원가입 승인 된 유튜브 채널 유저만 접근 할 수 있습니다. ( permission : restaurants.permissions.IsApprovedChannel )
POST
- 음식 대분류 데이터를 생성합니다.
- Admin user만 접근 할 수 있습니다. ( permission : IsAdminUser )
  url : /api/v1/foods/main/pk_num/
Other ( get / put / patch / delete )
- 음식 대분류의 데이터를 조회 / 수정 / 삭제 합니다.
- 정보의 수정이 필요 할 때 사용 할 수 있습니다.
- Admin user만 접근 할 수 있습니다. ( permission : IsAdminUser )

url : /api/v1/foods/sub

GET
- DB에 등록된 음식 소분류에 대한 정보를 리턴합니다.
- 유튜버가 웹에서 영상을 등록 할 때, 음식 소분류를 선택 할 때 사용 될 수 있습니다.
- 회원가입 승인 된 유튜브 채널 유저만 접근 할 수 있습니다. ( permission : restaurants.permissions.IsApprovedChannel )
POST
- 음식 소분류 데이터를 생성합니다.
- 회원가입 승인 된 유튜브 채널 유저만 접근 할 수 있습니다. ( permission : restaurants.permissions.IsApprovedChannel )

url : /api/v1/foods/sub/pk_num/

Other ( get / put / patch / delete )
- 음식 대분류의 데이터를 조회 / 수정 / 삭제 합니다.
- 정보의 수정이 필요 할 때 사용 할 수 있습니다.
- Admin user만 접근 할 수 있습니다. ( permission : IsAdminUser )

Users

API Info

유저에 대한 정보를 담고 있습니다.
URL scheme

url : /api/v1/users/
GET
- DB에 등록된 유저 목록들을 반환합니다.
- DB에 등록된 유저 정보들에 대한 정보가 필요 할 때 사용 할 수 있습니다.
- Admin user만 접근 할 수 있습니다. ( permission : IsAdminUser )
- Request / Response 에 대해서는 Redoc의 users 항목을 참고 하시면 됩니다.
POST
- 유저 데이터를 생성합니다.
- 회원가입을 할 때 사용 될 수 있습니다.
- sns_id ( facebook, google, apple 중 한가지 )와, username에 해당하는 값을 보내야 합니다.
- 누구든지 해당 정보에 접근 할 수 있습니다. ( permission : AllowAny )
- Request
  - username, sns_id가 반드시 필요합니다.
  - sns_id 종류는 google_id / facebook_id / apple_id가 있으며, 반드시 셋 중 한가지 항목의 값으로 보내주셔야 합니다.
- Response
  - 회원가입 성공 시 200 코드를 리턴합니다. ( 직접 클라이언트에서 확인 바랍니다. )
    url : /api/v1/users/pk_num/
Others ( GET / PUT / PATCH / DELETE )
- pk_num에 해당하는 유저 정보를 조회 / 수정 / 삭제 할 때 사용됩니다.
- pk_num에 해당하는 유저가, 요청한 유저와 같을 경우에만 접근 할 수 있습니다. ( permission : users.permissions.IsOwner )
- Request / Response 에 대해서는 Redoc의 users 항목을 참고 하시면 됩니다.

url : /api/v1/users/login

POST 메소드만 허용합니다.
로그인을 하기 위한 url 입니다.
username, sns_id ( google / facebook / apple 중 하나 )가 반드시 필요합니다.
상단의 정보로 인증을 진행 하고, 인증에 성공하면 유저 정보가 담긴 jwt를 반환 합니다.
JWT는 15일 동안 사용 가능하고, 그 뒤엔 만료됩니다.
만료된 토큰이거나, 위조된 토큰으로 통신을 시도하면 403 에러를 반환합니다. 이 경우 클라이언트에서는 재로그인을 진행 해 주세요.
인증에 실패하면 HTTP_401_UNAUTHORIZED 에러를 리턴하며, 이 경우엔 회원가입 api를 요청 해 주세요.
Request
- username, sns_id가 반드시 필요합니다.
- sns_id 종류는 google_id / facebook_id / apple_id가 있으며, 반드시 셋 중 한가지 항목의 값으로 보내주셔야 합니다.
Response
- Response 예시입니다. 실제 결과는 클라이언트 호출 후 확인 부탁 드립니다.
```
{
"token": "toooooooken",
"pk": 1234
}
```

Videos

API Info

영상에 대한 정보를 담고 있습니다.

URL scheme

url : /api/v1/videos/
GET
- DB에 등록된 영상 목록들을 반환합니다.
- channel_id / restaurant_id에 대해 필터링을 걸고 검색을 할 때에만 데이터를 받을 수 있습니다.
- channel_id / restaurant_id 값이 있으면, 누구든지 해당 정보에 접근 할 수 있습니다. ( permission : AllowAny )
- channel_id / restaurant_id 값이 없으면, 아무도 접근 할 수 없습니다.
- Request / Response 에 대해서는 Redoc의 videos 항목을 참고 하시면 됩니다.
POST
- 영상 데이터를 생성합니다.
- 영상 데이터를 유튜버가 등록 할 때 사용 될 수 있습니다.
- 회원가입 승인 된 유튜브 채널 유저만 접근 할 수 있습니다. ( permission : restaurants.permissions.IsApprovedChannel )
- Request
  - https://github.com/TeamPomPom/MukMap-Server/issues/25#issuecomment-729063172 를 참고 해 주세요.
- Response
  - 생성한 비디오의 상세 정보를 리턴합니다.
  - GET : /api/v1/videos/generated_video_pk/ 와 동일한 결과입니다. 클라이언트에서 확인 바랍니다.
    url : /api/v1/videos/pk_num/
GET
- pk_num에 해당하는 영상 정보를 조회 할 때 사용됩니다.
- 누구든지 해당 정보에 접근 할 수 있습니다. ( permission : AllowAny )
- Request / Response 에 대해서는 Redoc의 videos 항목을 참고 하시면 됩니다.
Others ( PUT / PATCH / DELETE )
- pk_num에 해당하는 영상 정보를 수정 / 삭제 할 때 사용됩니다.
- pk_num에 해당하는 영상 정보를 등록한 유저 ( 유튜버 채널 유저 )가, 요청한 유저와 같을 경우에만 접근 할 수 있습니다. ( permission : videos.permissions.IsOwnerOfVideo )
- Request / Response 에 대해서는 Redoc의 videos 항목을 참고 하시면 됩니다.

Apps

API Info

서비스 중인 앱에 대한 정보를 리턴합니다.
URL scheme

url : /api/v1/configs/latest_version/
GET
- platform ( os ), app_name을 주면 해당 platform / app의 min version / curr version / data version을 제공합니다.
- min version은 앱의 최소 버전을 의미하므로, 해당 버전보다 앱의 버전이 낮은 경우 강제 업데이트를 실시합니다.
- curr version은 현재 앱의 최신 버전을 의미합니다.
- data version은 현재 앱의 데이터 최신 버전을 의미합니다.
- 반드시 platform의 값으로 ios / android 둘중 하나의 값을 os에 맞도록 전송 해주셔야 합니다.
- 반드시 app_name의 값으로 앱의 고유 app_name을 전송 해주셔야 합니다. ( admin의 applicationkind 참조 )
- Request : api/v1/configs/latest_version/?platform=android&app_name=앱이름
- Response 예시입니다. 실제 결과는 클라이언트 호출 후 확인 부탁 드립니다.
```
{
"success": true,
"result": {
"curr_app_version": "0.1.0",
"min_app_version": "0.1.0",
"data_version": 1
},
"message": null
}
```

TeamPomPom / MukMap-Server