nodejs-crud-api v1.0.0

Movie API Project

Overview

This project is a simple RESTful API for managing a collection of movies. It supports basic CRUD operations: fetching all movies, adding new movies, updating existing movies, and deleting movies. The API is built using Node.js and the built-in HTTP module.

Features

• GET: Retrieve all movies or a specific movie by ID.
• POST: Add a new movie to the collection.
• PUT: Update an existing movie's details.
• DELETE: Remove a movie from the collection.

Endpoints

• GET /api/movies: Fetches all movies.
• GET /api/movies/:id: Fetches a specific movie by its ID.
• POST /api/movies: Adds a new movie. The request body must contain movie data in JSON format.
• PUT /api/movies/:id: Updates a specific movie by its ID. The request body must contain updated movie data.
• DELETE /api/movies/:id: Deletes a specific movie by its ID.

Project Structure

• server.js: Main server file where requests are routed based on HTTP methods (GET, POST, PUT, DELETE).
• methods/: Directory containing individual request handlers for GET, POST, PUT, and DELETE.
  • get-request.js: Handles retrieving movies.
  • post-request.js: Handles adding new movies.
  • put-request.js: Handles updating movies.
  • delete-request.js: Handles removing movies.
• util/: Directory containing utility functions.
  • body-parser.js: Parses the incoming request body.
  • write-to-file.js: Writes the updated movie list to a JSON file.
• data/: Directory containing the movies.json file, which stores the movie data.

Movie API Documentation

Base URL

The API's base URL is:

http://localhost:5000/api

Endpoints

1. GET /movies

   • Fetches all the movies from the database.

   • URL: /movies

   • Method: GET

   • Response:

     • 200 OK: Returns a list of movies.

   • Example Response:

        [
            {
                "id": "213976be-9157-4daa-992b-5b93f68540a6",
                "title": "The Wolf of Wall Street",
                "year": "2013",
                "genre": "Biography, Comedy, Crime",
                "rating": "8.2"
            },
            {
                "title": "Avatar 2",
                "year": "2020",
                "genre": "Action, Adventure, Fantasy",
                "rating": "7.9",
                "id": "9017c8f4-3406-474a-a528-bac9da1675d8"
            }
        ]

2. GET /movies/:id

   • Fetches a specific movie by its ID.

   • URL: /movies/:id

   • Method: GET
   • URL Parameter:
     • id (string, required): The UUID of the movie you want to retrieve.

   • Response:

     • 200 OK: Returns the movie with the specified ID.
     • 404 Not Found: Returned when no movie is found with the provided ID.
     • 400 Bad Request: Returned if the provided ID is not a valid UUID.

   • Example Response (Success):

        {
            "title": "The Avengers: Infinity war",
            "year": "2020",
            "genre": "Action, Adventure, Fantasy",
            "rating": "7.9",
            "id": "3711087e-2863-427e-86d8-1548c3e7b0db"
        }

   • Example Response (Not Found):

     {
       "title": "Not Found",
       "message": "Movie Not Found"
     }

3. POST /movies

   • Adds a new movie to the collection.

   • URL: /movies

   • Method: POST

   • Request Body (required):

     • The request body must contain the movie data in JSON format.

   • Example Request Body:

        {
          "title": "Inception",
          "year": "2010",
          "genre": "Action, Adventure, Fantasy",
          "rating": "7.9"
        }

   • Response:

     • 201 Created: Returns a success message with the created movie's ID.
     • 400 Bad Request: Returned when the request body is invalid or missing required fields.

4. PUT /movies/:id

   • Updates an existing movie by its ID.

   • URL: /movies/:id

   • Method: PUT
   • URL Parameter:
     • id (string, required): The UUID of the movie you want to update.

   • Request Body (required):

     • The request body must contain the updated movie data in JSON format.

   • Example Request Body:

        {
            "title": "Inception",
            "year": "2010",
            "genre": "Action, Adventure, Fantasy",
            "rating": "7.9"
        }

   • Response:

     • 200 OK: Returns the updated movie.
     • 404 Not Found: Returned when no movie is found with the provided ID.
     • 400 Bad Request: Returned when the provided ID is not valid or the request body is invalid.

5. DELETE /movies/:id

   • Deletes a specific movie by its ID.

   • URL: /movies/:id

   • Method: DELETE
   • URL Parameter:
     • id (string, required): The UUID of the movie you want to delete.
   • Response:
     • 204 No Content: Movie successfully deleted.
     • 404 Not Found: Returned when no movie is found with the provided ID.
     • 400 Bad Request: Returned if the provided ID is not valid.