API Documentation

1. Get All users (Dummy Data)

Method: GET

Path: /getUsers

Request Body: N/A

This endpoint returns a list of dummy users. No request needed.

Example Response:

[
    {
        "id": 1,
        "firstname": "User1",
        "lastname": "Lastname1",
        "mobileNumber": "919876543001",
        "avatar": "https://randomuser.me/api/portraits/men/1.jpg"
    },
    ...
]

2. Create User

Method: POST

Path: /createUser

Request Body:

{
    "firstname": "John",
    "lastname": "Doe",
    "mobileNumber": "919876543210",
    "avatar": "https://example.com/avatar.jpg"
}

Example Response:


                
                {
    "status": "success",
    "message": "User created successfully!",
    "data": {
        "id": 845,
        "firstname": "John",
        "lastname": "Doe",
        "mobileNumber": "919876543210",
        "avatar": "https://example.com/avatar.jpg"
    }
}

3. Update User - Patch

Method: PATCH

Path: /editUserwithPatch

Request Body:

{
    "id": 1,
    "firstname": "UpdatedFirstName",
    "lastname": "UpdatedLastName"
}

Example Response:

{
    "status": "success",
    "message": "User updated successfully!",
    "previousData": {
        "id": 1,
        "firstname": "User1",
        "lastname": "Lastname1",
        "mobileNumber": "919876543001",
        "avatar": "https://randomuser.me/api/portraits/men/1.jpg"
    },
    "updatedData": {
        "id": 1,
        "firstname": "UpdatedFirstName",
        "lastname": "UpdatedLastName",
        "mobileNumber": "919876543210",
        "avatar": "https://example.com/new_avatar.jpg"
    }
}

3. Update User - PUT

Method: PUT

Path: /editUserwithPut

Request Body:

{
    "id": 1,
    "firstname": "UpdatedFirstName",
    "lastname": "UpdatedLastName",
    "mobileNumber": "919876543210",
    "avatar": "https://example.com/new_avatar.jpg"
}

Example Response:

{
    "status": "success",
    "message": "User updated successfully!",
    "previousData": {
        "id": 1,
        "firstname": "User1",
        "lastname": "Lastname1",
        "mobileNumber": "919876543001",
        "avatar": "https://randomuser.me/api/portraits/men/1.jpg"
    },
    "updatedData": {
        "id": 1,
        "firstname": "UpdatedFirstName",
        "lastname": "UpdatedLastName",
        "mobileNumber": "919876543210",
        "avatar": "https://example.com/new_avatar.jpg"
    }
}

4. Delete User

Method: DELETE

Path: /deleteUser

Request Body:

{
    "id": 1
}

Example Response:

{
    "status": "success",
    "message": "User deleted successfully!"
}

5. User Login

Method: POST

Path: /login

Request Body:

{
    "username": "user1",
    "password": "password1"
}

Example Response:

{
    "status": "success",
    "token": "your_generated_token"
}

6. Access Protected Data

Method: GET

Path: /protectedData

Request Header:

Authorization: Bearer <your_token_here>

Example Response:

{
    "status": "success",
    "data": {
        "id": 1,
        "firstname": "User1",
        "lastname": "Lastname1",
        "email": "user1@example.com"
    }
}