Skip to content

C24-MR01/server

BranchesTags

Repository files navigation

NBS - Movie Recommendation System

RESTful APIs

API Reference

Register

  POST /api/v1/register
Parameter Type
username string
email string
password string
birth Date (YYYY-MM-DD)
gender int
name string
Request
  {
    "username" : "abc",
    "password" : "abcde",
    "email" : "abcd@gmail.com",
    "birth": "2000-01-01",
    "gender" : 0,
    "name" : "mencoba tes"
}
Response
  {
    "status" : 201,
    "message" : "account created"
  }

Login

  POST /api/v1/login
Parameter Type
email string
password string
Request
  {
    "email" : "test@gmail.com",
    "password" : "abcdefg",
}
Response
  {
    "token" : "${token}"
  }

Get User

  GET /api/v1/user/:userId
Parameter Type
userId string
Request
  {

  }
Response
  {
    "id": "xxxxxx",
    "name": "Christiano Ronaldo",
    "username": "ronaldo",
    "likes": [],
    "following": []
  }

Search User

  GET /api/v1/user?username=ronaldo
Query Type
username string
Request
  {

  }
Response
  [
    {
      "id": "xxxxxx",
      "name": "Christiano Ronaldo",
      "username": "ronaldo",
      "likes": [],
      "following": []
    }
  ]

Follow Friend

  PUT /api/v1/user/:userId/friend
Parameter Type
userId string
Request
  {

  }
Response
  {
    "message": "Friend added successfully"
  }

Delete Friend

  DELETE /api/v1/user/:userId/friend
Parameter Type
userId string
Request
  {

  }
Response
  {
    "message": "Friend removes successfully"
  }

Search Movies

  GET /api/v1/movie?name=kungfu
Query Type Description
name string Required. Movie name
include_adult boolean Including adult movie
language string Language of the movie
page string Page of the movie list
Request
{

}
Response
{
    page: 1,
    results: [
        {
            adult: false,
            backdrop_path: "/7d8OQyL43PVhhsnyBij6pN1y39A.jpg",
            genre_ids: [
                18
            ],
            id: 299848,
            original_language: "pl",
            original_title: "Kung-fu",
            overview: "A well-regarded engineer in a big enterprise is hounded by trumped up attacks on his integrity when he delves too deeply into how bonuses are handled by the management. He gets into an argument with the guard, is arrested and subsequently fired. An old friend, a journalist, tries to sort things out but the victim's stubbornness and past problems with his wife lead to lossess by both.",
            popularity: 8.05,
            poster_path: "/8lbhGDqavuV5SL2qPKQ04AVNt0x.jpg",
            release_date: "1980-03-17",
            title: "Kung-fu",
            video: false,
            vote_average: 6.3,
            vote_count: 3,
            cast: [
                {
                    "adult": false,
                    "gender": 1,
                    "id": 1102676,
                    "known_for_department": "Acting",
                    "name": "Teresa Sawicka",
                    "original_name": "Teresa Sawicka",
                    "popularity": 13.796,
                    "profile_path": "/zeHioEhaJrtAahfhRIhCervkpE0.jpg",
                    "cast_id": 2,
                    "character": "Irena Markowska",
                    "credit_id": "5e89cb8bb84f940016cc0ceb",
                    "order": 0
                },
                ...
            ]
        }
    ],
    total_pages: 8,
    total_results: 155
    
}

Get Movie with List of Ids

  POST /api/v1/movie/id
Request
{
   "movieIds": ["654", "655"]
}
Response
{
    "movies": [
        {
            "adult": false,
            "backdrop_path": "/pxkQAIhC7LXN5s5B23lnvCMgva5.jpg",
            "belongs_to_collection": null,
            "budget": 910000,
            "id": 654,
            .....
        },
        {
            "adult": false,
            "backdrop_path": "/moTOuNKnM2phZCYPF49Y1Hb7WJj.jpg",
            "belongs_to_collection": null,
            "budget": 1750000,
            "id": 655,
            .....
        }
    ]
}

Get Movies by Genre

  GET /api/v1/movie/genre?genre=action
Query Type Description
genre string Required. Genre of the movie
page string Page of the movie list
Request
{

}
Response
{
    page: 1,
    results: [
        {
        adult: false,
        backdrop_path: "/fqv8v6AycXKsivp1T5yKtLbGXce.jpg",
        genre_ids: [
            878,
            12,
            28
        ],
        id: 653346,
        original_language: "en",
        original_title: "Kingdom of the Planet of the Apes",
        overview: "Several generations in the future following Caesar's reign, apes are now the dominant species and live harmoniously while humans have been reduced to living in the shadows. As a new tyrannical ape leader builds his empire, one young ape undertakes a harrowing journey that will cause him to question all that he has known about the past and to make choices that will define a future for apes and humans alike.",
        popularity: 5180.717,
        poster_path: "/gKkl37BQuKTanygYQG1pyYgLVgf.jpg",
        release_date: "2024-05-08",
        title: "Kingdom of the Planet of the Apes",
        video: false,
        vote_average: 6.895,
        vote_count: 906
        }
    ]
}

Get Recent Movies

  GET /api/v1/movie/recent?type=now_playing&&page=1
Query Type Description
type string Required. type: popular or now_playing or upcoming
Request
{

}
Response

Note: type=popular doesn't have dates object, only {page, results, total_pages, total_results}

  {
    "dates": {
        "maximum": "2024-06-19",
        "minimum": "2024-05-08"
    },
    "page": 1,
    "results": [
      {
          "adult": false,
          "backdrop_path": "/fqv8v6AycXKsivp1T5yKtLbGXce.jpg",
          "genre_ids": [
              878,
              12,
              28
          ],
          "id": 653346,
          "original_language": "en",
          "original_title": "Kingdom of the Planet of the Apes",
          "overview": "Several generations in the future following Caesar's reign, apes are now the dominant species and live harmoniously while humans have been reduced to living in the shadows. As a new tyrannical ape leader builds his empire, one young ape undertakes a harrowing journey that will cause him to question all that he has known about the past and to make choices that will define a future for apes and humans alike.",
          "popularity": 3721.151,
          "poster_path": "/gKkl37BQuKTanygYQG1pyYgLVgf.jpg",
          "release_date": "2024-05-08",
          "title": "Kingdom of the Planet of the Apes",
          "video": false,
          "vote_average": 6.85,
          "vote_count": 985
      },
      ...
    ],
    "total_pages": 223,
    "total_results": 4457
  }

Get Movie

  GET /api/v1/movie/id/:movieId
Parameter Type Description
movieId string Required. ID of the movie
Request
{

}
Response
{
    adult: false,
    backdrop_path: "/3d8Y4q172YFp2obUdfMjyErB7eU.jpg",
    belongs_to_collection: {
        id: 389767,
        name: "My Big Fat Greek Wedding Collection",
        poster_path: "/oalS0sTGzk2mgiAyOQ5iVR4juJC.jpg",
        backdrop_path: "/UzzUEBULGUuk695tZhLO9xShxV.jpg"
    },
    budget: 5000000,
    genres: [
        {
            id: 35,
            name: "Comedy"
        },
        {
            id: 18,
            name: "Drama"
        },
        {
            id: 10749,
            name: "Romance"
        }
    ],
    homepage: "",
    id: 8346,
    imdb_id: "tt0259446",
    origin_country: [
        "CA",
        "US"
    ],
    original_language: "en",
    original_title: "My Big Fat Greek Wedding",
    overview: "A young Greek woman falls in love with a non-Greek and struggles to get her family to accept him while she comes to terms with her heritage and cultural identity.",
    popularity: 15.387,
    poster_path: "/ztc05ym0T3stnBpRHdxEs3Zwsmp.jpg",
    production_companies: [
        {
            id: 12026,
            logo_path: "/l1Y8SRH3EaElU2niZQLT3I8tOFp.png",
            name: "Gold Circle Films",
            origin_country: "US"
        },
        {
            id: 3268,
            logo_path: "/tuomPhY2UtuPTqqFnKMVHvSb724.png",
            name: "HBO",
            origin_country: "US"
        },
        {
            id: 95018,
            logo_path: null,
            name: "MPH Entertainment Productions",
            origin_country: ""
        },
        {
            id: 4171,
            logo_path: "/ip8rzankhLLhJGGkvfCirfUM26d.png",
            name: "Playtone",
            origin_country: "US"
        }
    ],
    production_countries: [
        {
            iso_3166_1: "CA",
            name: "Canada"
        },
        {
            iso_3166_1: "US",
            name: "United States of America"
        }
    ],
    release_date: "2002-04-19",
    revenue: 368744044,
    runtime: 95,
    spoken_languages: [
        {
            english_name: "Greek",
            iso_639_1: "el",
            name: "ελληνικά"
        },
        {
            english_name: "English",
            iso_639_1: "en",
            name: "English"
        }
    ],
    status: "Released",
    tagline: "Love is here to stay... so is her family.",
    title: "My Big Fat Greek Wedding",
    video: false,
    vote_average: 6.493,
    vote_count: 2055,
    trailerUrl: "https://www.youtube.com/watch?v=O2mecmDFE-Q",
    credits: {
        cast: [
            {
                adult: false,
                gender: 2,
                id: 819,
                known_for_department: "Acting",
                name: "Edward Norton",
                original_name: "Edward Norton",
                popularity: 21.174,
                profile_path: "/5XBzD5WuTyVQZeS4VI25z2moMeY.jpg",
                cast_id: 4,
                character: "Narrator",
                credit_id: "52fe4250c3a36847f80149f3",
                order: 0
            },
            ...
        ]
    }
}

Like Movie

  POST /api/v1/movie/id/:movieId/like
Parameter Type Description
movieId string Required. ID of the movie
Request
{

}
Response
{
    "message": "Movie liked successfully",
    "movie": "8346"
}

Unlike Movie

  DELETE /api/v1/movie/id/:movieId/like
Parameter Type Description
movieId string Required. ID of the movie
Request
{

}
Response
{
    "message": "Movie unliked successfully",
    "movie": "8346"
}

Get Movie Rating from C24-MR01 User

  GET /api/v1/movie/id/:movieId/rate
Parameter Type Description
movieId string Required. ID of the movie
Request
{

}
Response
{
    "ratings": {
        "${userId}": ${rating},
        "0rkTo09ySX": 80
    }
}

Rate Movie

  POST /api/v1/movie/id/:movieId/rate
Parameter Type Description
movieId string Required. ID of the movie
Request
{
    "rating": 75
}
Response
{
    "message": "Rating updated successfully",
    "movie": "8234464"
}

Update Movie's Rate

  PUT /api/v1/movie/id/:movieId/rate
Parameter Type Description
movieId string Required. ID of the movie
Request
{
    "rating": 75
}
Response
{
    "message": "Rating updated successfully!",
    "movie": "8234464"
}

About

No description, website, or topics provided.

Resources

Readme
Activity
Custom properties

Stars

0 stars

Watchers

0 watching

Forks

0 forks
Report repository

Releases

14 tags

Packages

 
 
 

Contributors

Languages