User Management API

This project provides a simple User Management API using Express.js. The API supports basic CRUD operations for managing users.

Features

• GET: Retrieve all users
• POST: Add a new user
• PUT: Update an existing user
• PATCH: Partially update an existing user
• DELETE: Remove a user

Installation

1. Clone the repository:

   git clone https://github.com/your-username/user-management-api.git

2. Navigate to the project directory:

   cd user-management-api

3. Install the dependencies:

   npm install

Usage

1. Start the server:

   npm start

2. The API will be available at http://localhost:3000.

API Endpoints

Get All Users

• Endpoint: GET /
• Response:

  {
    "message": "GET request received",
    "users": [],
    "status": true
  }

Add a New User

• Endpoint: POST /
• Request Body:

  {
    "name": "John Doe",
    "email": "[email protected]",
    "age": 30
  }

• Response:

  {
    "message": "User added successfully",
    "user": {
      "name": "John Doe",
      "email": "[email protected]",
      "age": 30
    },
    "status": true
  }

Update an Existing User

• Endpoint: PUT /:email
• Request Parameters:
  • email (string): The email of the user to update.
• Request Body:

  {
    "name": "Jane Doe",
    "age": 25
  }

• Response:

  {
    "message": "User updated successfully",
    "user": {
      "name": "Jane Doe",
      "email": "[email protected]",
      "age": 25
    },
    "status": true
  }

Partially Update an Existing User

• Endpoint: PATCH /:email
• Request Parameters:
  • email (string): The email of the user to update.
• Request Body:

  {
    "age": 35
  }

• Response:

  {
    "message": "User patched successfully",
    "user": {
      "name": "John Doe",
      "email": "[email protected]",
      "age": 35
    },
    "status": true
  }

Delete a User

• Endpoint: DELETE /:email
• Request Parameters:
  • email (string): The email of the user to delete.
• Response:

  {
    "message": "User deleted successfully",
    "user": {
      "name": "John Doe",
      "email": "[email protected]",
      "age": 30
    },
    "status": true
  }

Contributing

If you find any issues or have suggestions for improvement, please create a pull request or open an issue on GitHub.

License

This project is licensed under the MIT License. See the LICENSE file for details.

Replace the placeholder URL (https://github.com/your-username/user-management-api.git) with the actual URL of your repository. Adjust the request body examples and response formats as per your actual data structure and requirements.