코드잇

2023. 4. 3

Watchit API 문서

코드잇 실습용 서버 호스트

코드잇 실습용 서버 호스트입니다.

 learn.codeit.kr

영화 (Movie)

영화 데이터를 저장합니다.

엔드포인트


    GET /api/watchit/movies/
    GET /api/watchit/movies/:id

영화 객체

속성

id: int

영화 객체에 대한 고유 식별자.

title: string

영화의 제목.

englishTitle: string

영화의 영어 제목.

posterUrl: string

영화 포스터 이미지 주소.

date: string

영화 개봉일.

genre: string

영화 장르.

country: string

영화 개봉 국가.

rating: enum

영화의 상영 등급. '12'(12세 이상 관람가), '15'(15세 이상 관람가), '19'(미성년자 관람 불가), 'all'(전체 관람가) 중에서 하나를 값으로 갖습니다.

runningTime: int

영화의 상영 시간(분).

movieCode: string

영화 코드.

starRating: int

영화 별점. 0보다 크거나 같고 5보다 작거나 같은 정수.

description: string

영화에 대한 설명.

createdAt: timestamp

객체가 생성된 시점에 대한 타임스탬프.

updatedAt: timestamp

객체가 수정된 시점에 대한 타임스탬프.

설문 객체 예시

{
  "id": 1,
  "title": "올드보이",
  "englishTitle": "Old boy",
  "posterUrl": "https://learn-codeit-kr-static.s3.ap-northeast-2.amazonaws.com/watchit/movie-01.jpeg",
  "date": "2003.11.21",
  "genre": "스릴러",
  "country": "한국",
  "rating": "19",
  "runningTime": 120,
  "starRating": 4,
  "description": "술 좋아하고 떠들기 좋아하는 오.대.수. 본인의 이름풀이를 ‘오늘만 대충 수습하며 살자’라고 이죽거리는 이 남자는 아내와 어린 딸아이를 가진 지극히 평범한 샐러리맨이다. 어느 날, 술이 거나하게 취해 집에 돌아가는 길에 존재를 알 수 없는 누군가에게 납치, 사설 감금방에 갇히게 되는데...",
  "createdAt": 1677842000,
  "updatedAt": 1677842000,
}

여러 영화 조회

엔드포인트

GET /api/watchit/movies/

영화 객체 전체 목록을 최신 순서로 리턴합니다.

쿼리 스트링 파라미터

q: string

제목을 검색할 검색어. 쿼리 스트링 파라미터로 보내면 해당 문자열을 제목에 포함한 영화들만 모아서 확인할 수 있습니다.

limit: int

리턴받기 원하는 설문 객체 수. 값을 전달하지 않으면 10개의 객체가 리턴됩니다. 10~100 사이 정수만 허용됩니다.

offset: int

가장 앞 객체부터 건너뛰고 싶은 객체 수. 값을 전달하지 않으면 건너뛰지 않습니다.

리턴 내용

유효한 쿼리 스트링을 제공했을 시, 영화 객체 목록이 리턴됩니다. 실패 시, 에러 상태 코드와 메세지가 리턴됩니다.

count: int

해당하는 총 영화 객체 수.

next: string

페이지네이션에서 다음 페이지에 해당하는 주소.

previous: string

페이지네이션에서 이전 페이지에 해당하는 주소.

results: Movie[]

리턴된 영화 객체 목록.

리퀘스트 예시

GET https://learn.codeit.kr/api/watchit/movies/?q=괴물

리스폰스 예시

상태 코드: 200

{
  "count": 1,
  "next": null,
  "previous": null,
  "results": [
    {
      "createdAt": 1678101000,
      "updatedAt": 1678101000,
      "id": 8,
      "title": "괴물",
      "englishTitle": "The Host",
      "posterUrl": "https://learn-codeit-kr-static.s3.ap-northeast-2.amazonaws.com/watchit/movie-08.jpeg",
      "date": "2006.07.27.",
      "genre": "스릴러/가족/드라마/SF",
      "country": "한국",
      "rating": "12",
      "runningTime": 119,
      "starRating": 4,
      "description": "햇살 가득한 평화로운 한강 둔치 아버지(변희봉)가 운영하는 한강매점, 늘어지게 낮잠 자던 강두(송강호)는 잠결에 들리는 ‘아빠’라는 소리에 벌떡 일어난다. 올해 중학생이 된 딸 현서(고아성)가 잔뜩 화가 나있다. 꺼내놓기도 창피한 오래된 핸드폰과 학부모 참관 수업에 술 냄새 풍기며 온 삼촌(박해일)때문이다. 강두는 고민 끝에 비밀리에 모아 온 동전이 가득 담긴 컵라면 그릇을 꺼내 보인다. 그러나 현서는 시큰둥할 뿐, 막 시작된 고모(배두나)의 전국체전 "
    }
  ]
}

영화 조회

엔드포인트

GET /api/watchit/movies/:id

URL 파라미터 :id 에 해당하는 설문 객체를 조회합니다.

파라미터

없음.

리턴 내용

유효한 고유 식별자를 제공했을 시 설문 객체가 리턴됩니다. 실패 시, 에러 상태 코드와 메세지가 리턴됩니다.

리퀘스트 예시

GET https://learn.codeit.kr/api/watchit/movies/1

리스폰스 예시

상태 코드: 200

{
  "createdAt": 1678101000,
  "updatedAt": 1678101000,
  "id": 8,
  "title": "괴물",
  "englishTitle": "The Host",
  "posterUrl": "https://learn-codeit-kr-static.s3.ap-northeast-2.amazonaws.com/watchit/movie-08.jpeg",
  "date": "2006.07.27.",
  "genre": "스릴러/가족/드라마/SF",
  "country": "한국",
  "rating": "12",
  "runningTime": 119,
  "starRating": 4,
  "description": "햇살 가득한 평화로운 한강 둔치 아버지(변희봉)가 운영하는 한강매점, 늘어지게 낮잠 자던 강두(송강호)는 잠결에 들리는 ‘아빠’라는 소리에 벌떡 일어난다. 올해 중학생이 된 딸 현서(고아성)가 잔뜩 화가 나있다. 꺼내놓기도 창피한 오래된 핸드폰과 학부모 참관 수업에 술 냄새 풍기며 온 삼촌(박해일)때문이다. 강두는 고민 끝에 비밀리에 모아 온 동전이 가득 담긴 컵라면 그릇을 꺼내 보인다. 그러나 현서는 시큰둥할 뿐, 막 시작된 고모(배두나)의 전국체전 "
}

영화 리뷰 (Movie Review)

영화에 대한 영화 리뷰 후기를 저장합니다.

엔드포인트

   POST /api/watchit/movie_reviews/
    GET /api/watchit/movie_reviews/

영화 리뷰 객체

속성

id: int

설문 객체에 대한 고유 식별자.

sex: enum

작성자의 성별. 'male', 'female', 'none' 중에서 하나의 값을 갖습니다.

age: int

작성자의 나이.

starRating: int

영화에 대한 별점 0보다 크거나 같고 5보다 작거나 같은 정수

movieId: int

해당하는 영화의 아이디.

createdAt: timestamp

객체가 생성된 시점에 대한 타임스탬프.

updatedAt: timestamp

객체가 수정된 시점에 대한 타임스탬프.

영화 리뷰 객체 예시

{
  "id": 1,
  "sex": "male",
  "age": 20,
  "starRating": 4,
  "movieId": 1,
  "createdAt": 1676263021000,
  "updatedAt": 1676263021000
}

영화 리뷰 생성

엔드포인트

POST /api/watchit/movie_reviews/

파라미터로 넘겨준 값들을 사용해서 새로운 영화 리뷰 객체를 생성합니다.

바디 파라미터

sex: enum

작성자의 성별. 'male', 'female', 'none' 중에서 하나의 값을 갖습니다.

age: int

작성자의 나이.

starRating: int

영화에 대한 별점 0보다 크거나 같고 5보다 작거나 같은 정수

movieId: int

해당하는 영화의 아이디.

리턴 내용

생성에 성공할 시, 영화 리뷰 객체가 리턴됩니다. 실패 시, 에러 상태 코드와 메세지가 리턴됩니다.

리퀘스트 예시

POST https://learn.codeit.kr/api/watchit/movie_reviews/
Content-Type: application/json

{
  "sex": "male",
  "age": 20,
  "starRating": 4,
  "movieId": 1,
}

리스폰스 예시

상태 코드: 201

{
  "id": 1,
  "sex": "male",
  "age": 20,
  "starRating": 4,
  "movieId": 1,
  "createdAt": 1676263021000,
  "updatedAt": 1676263021000
}

여러 영화 리뷰 조회

엔드포인트

GET /api/watchit/movie_reviews/

영화 리뷰 객체 전체 목록을 최신 순서로 리턴합니다.

쿼리 스트링 파라미터

movie_id: int

영화 리뷰가 작성된 영화의 아이디. 쿼리 스트링 파라미터로 보내면 해당 영화에 대한 영화 리뷰만 모아서 확인할 수 있습니다.

limit: int

리턴받기 원하는 영화 객체 수. 값을 전달하지 않으면 10개의 객체가 리턴됩니다. 10~100 사이 정수만 허용됩니다.

offset: int

가장 앞 객체부터 건너뛰고 싶은 객체 수. 값을 전달하지 않으면 건너뛰지 않습니다.

리턴 내용

유효한 쿼리스트링을 제공했을 시, 영화 리뷰 객체 목록이 리턴됩니다. 실패 시, 에러 상태 코드와 메세지가 리턴됩니다.

count: int

해당하는 총 영화 리뷰 객체 수.

next: string

페이지네이션에서 다음 페이지에 해당하는 주소.

previous: string

페이지네이션에서 이전 페이지에 해당하는 주소.

results: MovieReview[]

리턴된 영화 리뷰 객체 목록.

리퀘스트 예시

GET https://learn.codeit.kr/api/watchit/movie_reviews/?movie_id=1&limit=2&offset=4

리스폰스 예시

상태 코드: 200

{
  "count": 7,
  "next": "https://learn.codeit.kr/api/watchit/movie_reviews/?movie_id=1&limit=2&offset=6",
  "previous": "https://learn.codeit.kr/api/watchit/movie_reviews/?movie_id=1&limit=2&offset=2",
  "results": [
    {
      "id": 3,
      "sex": "male",
      "age": 30,
      "starRating": 5,
      "movieId": 1,
      "createdAt": 1676169421000,
      "updatedAt": 1676263021000
    },
    {
      "id": 2,
      "sex": "female",
      "age": 10,
      "starRating": 2,
      "movieId": 1,
      "createdAt": 1676176621000,
      "updatedAt": 1676263021000
    }
  ]
}

이 튜토리얼은 어땠나요?