This project is a RESTful API built with Node.js, Express, and MySQL. It provides endpoints to manage employees in a database, allowing CRUD operations such as creating, reading, updating, and deleting employee records.

• CRUD Operations: Perform operations on employee data; fetching all employees, fetching an employee by ID, adding a new employee, updating employee information, and deleting an employee.
• MySQL Integration: Uses MySQL for data storage and retrieval.
• Environment Configuration: Utilizes environment variables for secure configuration.
• Modular Architecture: Organized codebase with controllers, routes, and configuration modules.
• Error Handling: Handles errors with meaningful responses.

• Node.js: JavaScript runtime for server-side development.
• Express.js: Minimalist web framework for building web applications.
• MySQL2: Library for connecting to the MySQL database.
• dotenv: For managing environment variables.
• Nodemon: For development convenience with automatic server restarts.

• Node.js installed on your system.
• MySQL database set up and running.

1. Clone the repository:

   git clone https://github.com/MartinXCVI/node-mysql-rest-api.git cd node-mysql-rest-api

2. Install dependencies:

   npm install

3. Configure environment variables:

   Create a .env file in the root directory and add the following variables:

   PORT=3000 DB_USER=<user> DB_PASS=<password> DB_HOST=localhost DB_NAME=<database> DB_PORT=3306

4. Start the server:

   In development mode:

   npm run dev

   In production mode:

   npm start

5. Test the API:

   The server will start at http://localhost:3000. Use a tool like Postman or Insomnia to test the endpoints.

http://localhost:3000/api

• URL: /ping
• Method: GET
• Description: Verifies that the server is running.
• Response:

  { "result": "Pong" }

• URL: /employees
• Method: GET
• Description: Fetch all employee records.
• Response:

  [ { "id": 1, "name": "John Doe", "salary": 50000 }, { "id": 2, "name": "Jane Smith", "salary": 60000 } ]

• URL: /employees/:id
• Method: GET
• Description: Fetch a specific employee by ID.
• Response (Success):

  { "id": 1, "name": "John Doe", "salary": 50000 }

• Response (Not Found):

  { "message": "Employee not found or does not exist" }

• URL: /employees
• Method: POST
• Description: Add a new employee.
• Request Body:

  { "name": "Alice", "salary": 55000 }

• Response:

  { "id": 3, "name": "Alice", "salary": 55000 }

• URL: /employees/:id
• Method: PATCH
• Description: Update an existing employee's details.
• Request Body:

  { "name": "Alice Johnson", "salary": 58000 }

• Response:

  [ { "id": 3, "name": "Alice Johnson", "salary": 58000 } ]

• URL: /employees/:id
• Method: DELETE
• Description: Delete an employee by ID.
• Response (Success): Status Code 204 (No Content).
• Response (Not Found):

  { "message": "Employee not found or does not exist" }

project-root/ ├── node_modules ├── src/ │ ├── config/ │ │ ├── config.js # Environment variables configuration │ │ ├── dbConnection.js # MySQL connection pool │ ├── controllers/ │ │ ├── employees.controllers.js # CRUD logic for employees │ │ ├── index.controllers.js # Ping endpoint │ ├── routes/ │ │ ├── employees.routes.js # Routes for employees │ │ ├── index.routes.js # Route for ping │ ├── app.js # Express application setup │ └── index.js # Entry point ├── .env # Environment variables file ├── .gitignore ├── package-lock.json ├── package.json └── README.md # Project documentation 

• Node.js latest documentation
• Nodemon project website
• Getting started with Express.js
• Dotenv repository
• MySQL2 official documentation

• MartinXCVI