Contacts_REST_API

A RESTful API built with Node.js and Express for managing contacts. It supports CRUD operations and utilizes MySQL for data storage.

I ran MySQL in a Docker container, made use of Docker volumes to ensure data persists even after the container is stopped or removed.

Used POSTMAN to test the API.

This API only runs locally for now 😭😭😭, I plan to host the database and the API in the future if I decide to proceed with deployment.

Steps to run the API given below.

Note: Please excuse the large amount of comments in my code, they are for review (when I comeback to this later).

API Endpoints

Working Screenshots

GET (All Contacts)

GET (Contact By ID)

POST ( Create Contact)

PUT ( Update Contact)

DELETE (Delete Contact by id)

How To Use The API

To run the API locally, follow these steps:

1. Clone the Repository

   git clone https://github.com/your-username/contacts-api.git
   cd contacts-api
   

2. Install Dependencies

    npm install
   

3. Create Database contacts(In MYSQL)

   CREATE DATABASE contacts
   

4. Create Table Contacts (IN MYSQL)

   USE contacts;
    CREATE TABLE Contacts (
    id INT PRIMARY KEY,
    name VARCHAR(255) NOT NULL,
    number VARCHAR(15) NOT NULL
    );
   

5. Change MYSQL_PASSWORD To Your Password In The Dotenv File

6. Start The Application

    npm start

7. Test The API Via POSTMAN / OPENAPI