stix2you/myflix_api

A API built with Node.js and Express, to access a movie database built using MongoDB and business logic modelled with Mongoose. The API leverages REST architechture to provide json data about different movies, genres, and directors. The Database and API also includes user registration/login functionality.

myFlix API Documentation

Description

A API built with Node.js and Express, to access a movie database built using MongoDB and business logic modelled with Mongoose. The API leverages REST architechture to provide json data about different movies, genres, and directors. The Database and API also includes user functionality, allowing users to create an account, update their information, and add or remove movies to their list of favorites.

See also documentation.html in public folder for further API call information.

Dependencies:

Standard Dependencies:

  "bcrypt": "^5.1.1",
  "body-parser": "^1.20.2",
  "cors": "^2.8.5",
  "express": "^4.18.2",
  "express-validator": "^7.0.1",
  "jsonwebtoken": "^9.0.2",
  "mongodb": "^6.3.0",
  "mongoose": "^8.1.2",
  "morgan": "^1.10.0",
  "passport": "^0.7.0",
  "passport-jwt": "^4.0.1",
  "passport-local": "^1.0.0",
  "uuid": "^9.0.1"

Dev Dependencies:

  "jsdoc": "^4.0.3",
  "nodemon": "^3.0.3"

API URL

https://stix2you-myflix-5cbcd3c20372.herokuapp.com

API Endpoints

Request	URL	HTTP Method	Request Body Data Format	Response Body Data Format
Get list of all movies	/movies	GET	None	An array of JSON objects holding movie information
Get information about a specific movie	/movies/[title]	GET	None	A JSON object holding data about the movie
Get information about a specific genre	/genres/[genre]	GET	None	A JSON object holding data about the genre
Get information about a specific director	/directors/[director]	GET	None	A JSON object holding data about the director
Add a user	/users	POST	A JSON object holding user data	A JSON object holding data about the added user
Update user details	/users/[current username]	PUT	A JSON object holding updated user data	A JSON object holding data about the updated user
Add a movie to a user's favorites list	/users/[username]/movies/[movie_ID]	POST	None	A JSON object showing updated favorite_movies
Remove a movie from a user's favorites list	/users/[username]/movies/[movie_ID]	DELETE	None	A message indicating the movie was removed
Remove a user	/users/[username]	DELETE	None	A message indicating the user was removed
Get list of all users	/users	GET	None	An array of JSON objects holding user information
Get data for a single user	/users/[username]	GET	None	A JSON object holding user information
Login	/login/?username=[username]&password=[password]	POST	None	A JSON object holding user information and BEARER TOKEN to be used with all other API calls

Bearer Token:

All calls except LOGIN must include the BEARER TOKEN in the Authorization header. BEARER TOKEN is received during the LOGIN call.

Example Records:

Get list of all movies

Request:
GET .../movies

Response:

[
  {
    "_id": "movie_pulpfiction000",
    "Title": "Pulp Fiction",
    "ReleaseYear": "1994",
    "Rating": "R",
    "Runtime": "2h 34m",
    "Description": "(Movie Description Here).",
    "Genres": [
      "genre_crime000",
      "genre_drama000"
    ],
    "Director": [
      "director_quentintarantino000"
    ],
    "Actors": [
      "actor_johntravolta000",
      "actor_samuelljackson000",
      "actor_umathurman000"
    ],
    "ImagePath": "https://image_url.jpg",
    "Featured": true
  }
]

... list continues ...

Get information about a specific movie:

Request:
GET .../movies/Pulp%20Fiction

Response:

{
    "_id": "movie_pulpfiction000",
    "Title": "Pulp Fiction",
    "ReleaseYear": "1994",
    "Rating": "R",
    "Runtime": "2h 34m",
    "Description": "(Movie Descripsion Here).",
    "Genres": [
        "genre_crime000",
        "genre_drama000"
    ],
    "Director": [
        "director_quentintarantino000"
    ],
    "Actors": [
        "actor_johntravolta000",
        "actor_samuelljackson000",
        "actor_umathurman000"
    ],
    "ImagePath": "https://image_url.jpg",
    "Featured": true
}

Get information about a specific genre:

Request:
GET .../genres/Drama

Response:

{
    "_id": "genre_drama000",
    "name": "Drama",
    "description": "Genre Description Here."
}

Get information about a specific director:

Request: GET .../directors/Steven%20Spielberg

Response:

{
    "_id": "director_stevenspielberg000",
    "name": "Steven Spielberg",
    "birthDate": "1946-12-18",
    "deathDate": null,
    "bio": "Director Bio Here.",
    "imagePath": "https://image_url.jpg"
}

Add a User:

Request: POST .../users

Payload:

{
    "username": "jackolanternnn",  (String)
    "password": "password123!!!!",   (String)
    "email": "[email protected]",   (String)
    "birthday": "1995-10-31"   (Date)
}

Response:

{
    "username": "jackolanternnn",
    "password": "password123!!!!",
    "email": "[email protected]",
    "birthday": "1995-10-31T00:00:00.000Z",
    "favorite_movies": [],
    "_id": "65cacb968d267bac3742a800",
    "__v": 0
}

Update Username, Password, Email, or Birthday:

Request: PUT .../users/jackolantern

Payload:

{
    "username": "JackNewName",  (String)
    "password": "password123!!!!",  (String)
    "email": "[email protected]",   (String)
    "birthday": "1995-10-31"   (Date)
}

Response:

{
    "_id": "65cacb968d267bac3742a800",
    "username": "JackNewName",
    "password": "password123!!!!",
    "email": "[email protected]",
    "birthday": "1995-10-31T00:00:00.000Z",
    "favorite_movies": [],
    "__v": 0
}

Add a movie to a user's favorites list:

Request: POST .../users/jackolantern/movies/movie_pulpfiction000

Response:

{
    "_id": "65cacb968d267bac3742a800",
    "username": "jackolantern",
    "password": "password123!!!!",
    "email": "[email protected]",
    "birthday": "1995-10-31T00:00:00.000Z",
    "favorite_movies": [
        "movie_pulpfiction000"
    ],
    "__v": 0
}

Remove a movie from a user's favorites list:

Request: DELETE .../users/jackolantern/movies/movie_pulpfiction000

Response: "Pulp Fiction was removed from the user's favorite list!"

Remove a user:

Request: DELETE .../users/jackolantern

Response: "jackolantern was removed from the user database!"

Get List of All Users:

Request: GET .../users

Response:

{
    "_id": "65c2dd36714b2df1114d6a84",
    "first_name": "Sarah",
    "last_name": "Garcia",
    "username": "sarahgarcia",
    "password": "Password8!",
    "birthday": "1987-06-18",
    "favorite_movies": [
        "movie_savingprivateryan000",
        "movie_themagnificentseven000"
    ]
}

... list continues ... 

Get Data for a Single User:

Request: GET .../users/jackolantern

Response:

{
    "_id": "65cadb7dd1468d0e5725c735",
    "username": "jackolantern",
    "password": "password123!!!!",
    "email": "[email protected]",
    "birthday": "1995-10-31T00:00:00.000Z",
    "favorite_movies": [],
    "__v": 0
}

User Login

Request: POST .../login/?username=username70&password=password

Response:

{
    "user": {
        "_id": "664e73c7abcbc64f402245d9",
        "username": "username70",
        "password": "$2b$10$VI7kE9iXK7trmJYPfREuwukES49oQTKhisDf77rE72x9GS8gJS5ma",
        "email": "[email protected]",
        "birthday": "1995-10-31T00:00:00.000Z",
        "favorite_movies": [],
        "__v": 0
    },
    "token": "Bearer_Token_Here"
}