Skip to content

Home

Jump to bottom
Mohammad Faisal Khatri edited this page Sep 8, 2024 · 3 revisions

Welcome to the restful-ecommerce wiki!

A simple Node E-Commerce application for testing RESTful web services.

API Documentation

Health Check API

This API will perform Health check of the App and confirm the status if it is UP and Running

http://localhost:3004/health

Expected Response

Status Code : 200

Body

{
    "status": "UP and Running",
    "uptime": "103.842424208 seconds",
    "timestamp": "2024-09-08T08:53:31.956Z"
}

Validations

  1. If the App is not running, it will return status code 400 with status: 'DOWN and OUT!' alongwith the error message.

POST Orders

This API will allow adding new orders.

curl -X POST http://localhost:3004/addOrder \
-H "Content-Type: application/json" \
-d '{
    "user_id": "12345",
    "product_id": "98765",
    "product_name": "Cool Gadget",
    "product_amount": 100.00,
    "qty": 2,
    "tax_amt": 10.00,
    "total_amt": 220.00
}'

Request Payload should be an array of Objects as below:

[ { 
    "user_id": "1",
    "product_id": "1",
    "product_name": "iPhone",
    "product_amount": 500.00,
    "qty": 1,
    "tax_amt": 5.99,
    "total_amt": 505.99
},
{
    "user_id": "1",
    "product_id": "2",
    "product_name": "iPad",
    "product_amount": 699.00,
    "qty": 1,
    "tax_amt": 7.99,
    "total_amt": 706.99
},
{
    "user_id": "2",
    "product_id": "2",
    "product_name": "iPhone 15 PRO",
    "product_amount": 999.00,
    "qty": 2,
    "tax_amt": 9.99,
    "total_amt": 1088.99
},
{
    "user_id": "3",
    "product_id": "3",
    "product_name": "Samsung S24 Ultra",
    "product_amount": 4300.00,
    "qty": 1,
    "tax_amt": 5.99,
    "total_amt": 4305.99
}]

Expected Response

Status Code : 201

Body

{
    "message": "Orders added successfully!",
    "orders": [
        {
            "id": 1,
            "user_id": "1",
            "product_id": "1",
            "product_name": "iPhone",
            "product_amount": 500,
            "qty": 1,
            "tax_amt": 5.99,
            "total_amt": 505.99
        },
        {
            "id": 2,
            "user_id": "1",
            "product_id": "2",
            "product_name": "iPad",
            "product_amount": 699,
            "qty": 1,
            "tax_amt": 7.99,
            "total_amt": 706.99
        },
        {
            "id": 3,
            "user_id": "2",
            "product_id": "2",
            "product_name": "iPhone 15 PRO",
            "product_amount": 999,
            "qty": 2,
            "tax_amt": 9.99,
            "total_amt": 1088.99
        },
        {
            "id": 4,
            "user_id": "3",
            "product_id": "3",
            "product_name": "Samsung S24 Ultra",
            "product_amount": 4300,
            "qty": 1,
            "tax_amt": 5.99,
            "total_amt": 4305.99
        }
    ]
}

Validations

  1. Request Payload should be an array of Objects else status code 400 Bad request will be shown
  2. Request Payload should contain the following fields mandatorily: user_id, product_id, product_name, product_amount, qty, tax_amt, and total_amt else 400 Bad request will be shown
  3. "Id" field should be auto incremented when an order is added
  4. Currently, no check is added for duplicate orders

GET All Orders

This API will fetch all the orders available in the system.

curl -X GET http://localhost:3004/getAllOrders

Expected Response

This API will fetch all the available orders.

Status Code : 200

Body

{
    "message": "Orders fetched successfully!",
    "orders": [
        {
            "id": 1,
            "user_id": "1",
            "product_id": "1",
            "product_name": "iPhone",
            "product_amount": 500,
            "qty": 1,
            "tax_amt": 5.99,
            "total_amt": 505.99
        },
        {
            "id": 2,
            "user_id": "1",
            "product_id": "2",
            "product_name": "iPad",
            "product_amount": 699,
            "qty": 1,
            "tax_amt": 7.99,
            "total_amt": 706.99
        },
        {
            "id": 3,
            "user_id": "2",
            "product_id": "2",
            "product_name": "iPhone 15 PRO",
            "product_amount": 999,
            "qty": 2,
            "tax_amt": 9.99,
            "total_amt": 1088.99
        },
        {
            "id": 4,
            "user_id": "3",
            "product_id": "3",
            "product_name": "Samsung S24 Ultra",
            "product_amount": 4300,
            "qty": 1,
            "tax_amt": 5.99,
            "total_amt": 4305.99
        }
    ]
}

Validations

  1. Response should be a JSON object
  2. Two fields should be fetched in the response, 1. message and 2. An array of Order Objects
  3. Order object should contain the following fields with values
     {
            "id": 1,
            "user_id": "1",
            "product_id": "1",
            "product_name": "iPhone",
            "product_amount": 500,
            "qty": 1,
            "tax_amt": 5.99,
            "total_amt": 505.99
        }
  1. If no records are found following response should be displayed

*** Status Code - 404 ***

{
    "message": "No Order found!!"
}

GET Orders filtered on Order Id, User Id, Product Id

This API will fetch the orders as per the Query param - id, user_id or product_id

Fetch Orders by Order Id

curl -X GET "http://localhost:3004/getOrder?id=1

Fetch Orders by User Id

curl -X GET "http://localhost:3004/getOrder?user_id=1

Fetch Orders by Product Id

curl -X GET "http://localhost:3004/getOrder?product_id=1

Fetch Orders by multiple query parameters

curl -X GET "http://localhost:3004/getOrder?id=1&product_id=1

Query Parameters

  1. id
  2. user_id
  3. product_id

Expected Response

Data filtered according to the query parameter supplied in request should be returned in the response as follows:

Status Code : 200

Body

{
    "message": "Order found!!",
    "orders": [
        {
            "id": 1,
            "user_id": "1",
            "product_id": "1",
            "product_name": "iPhone",
            "product_amount": 500,
            "qty": 1,
            "tax_amt": 5.99,
            "total_amt": 505.99
        }
    ]
}

Validations

  1. Fetch the records based on id (order id), product_id, user_id individually or clubbing all the three query parameters with AND condition
  2. When no records are available for the query parameter, then status code 404 should be displayed with the following message in the response: Response Body 
{
    "message": "No Order found with the given parameters!"
}

PUT - Update Order details

This API will update the order details. It requires Authentication token in the request header that could be taken using the /auth API.

curl --location --request PUT 'http://localhost:3004/updateOrder/1' \
--header 'Content-Type: application/json' \
--header 'Authorization: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VybmFtZSI6ImFkbWluIiwiaWF0IjoxNzI1MzU1MTM0LCJleHAiOjE3MjUzNTg3MzR9.URm8jqhNUPhXjbcDzrbWp7K9RK8boZw-4s1WTtGgnI0' \
--data '{
    "user_id": "1",
    "product_id": "5",
    "product_name": "Samsung Galaxy S24 Ultra",
    "product_amount": 14337.00,
    "qty": 5,
    "tax_amt": 90.00,
    "total_amt": 14427.00
    }'

Request Payload should be an Object

{
    "user_id": "1",
    "product_id": "5",
    "product_name": "Samsung Galaxy S24 Ultra",
    "product_amount": 14337.00,
    "qty": 5,
    "tax_amt": 90.00,
    "total_amt": 14427.00
    }

Expected Response

Status Code : 200

Body

{
  "message": "Order updated successfully!",
  "order": {
    "order_id": 1,
    "user_id": "12345",
    "product_id": "98765",
    "product_name": "Updated Gadget",
    "product_amount": 120.00,
    "qty": 3,
    "tax_amt": 12.00,
    "total_amt": 372.00
  }
}

Validations

  1. Request Payload should contain the following fields mandatorily: user_id, product_id, product_name, product_amount, qty, tax_amt, and total_amt else 400 Bad request should be displayed.
  2. If Order Id does not exists, then status code 404 should be displayed with the following message :
{
"message": "Order not found!" 
}
  1. Currently, no check is added for duplicate orders
  2. If Authentication token is not provided, then status code - 403 should be displayed with the following message in response:
{
"message": "Forbidden! Token is missing!",
}
  1. If token validation fails, then status code - 404 should be displayed with the following message in response:
{
  "message": "Failed to authenticate token!",
}

PATCH - Update Specific Order detail

This API will allow updating specific order detail. It requires Authentication token in the request header that could be taken using the /auth API.

curl --location --request PATCH 'http://localhost:3004/partialUpdateOrder/1' \
--header 'Content-Type: application/json' \
--header 'Authorization: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VybmFtZSI6ImFkbWluIiwiaWF0IjoxNzI1MzU1MTM0LCJleHAiOjE3MjUzNTg3MzR9.URm8jqhNUPhXjbcDzrbWp7K9RK8boZw-4s1WTtGgnI0' \
--data '{
    "product_name": "iPhone 15 Pro Max"
}'

Request Payload should be an Object

Any specific detail of the order can be updated using this API

{
 "product_name": "iPhone 15 pro max"
}

Expected Response

Status Code : 200

Body

{
  "message": "Order updated successfully!",
  "order": {
    "id": 1,
    "user_id": "1",
    "product_id": "98765",
    "product_name": "iPhone 15 Pro Max",
    "product_amount": 120.00,
    "qty": 3,
    "tax_amt": 12.00,
    "total_amt": 372.00
  }
}

Validations

  1. Any valid field of the Order can be updated using this API
  2. If Order Id does not exists, then status code 404 should be displayed with following message in the response
{
    "message": "Order not found!"
}
  1. Currently, no check is added for duplicate orders.
  2. If Authentication token is not provided, then status code 403 should be displayed with the following message in response:
{
"message": "Forbidden! Token is missing!",
}
  1. If token validation fails, then status code - 404 should be displayed with the following message in response:
{
  "message": "No Order found with the given Order Id!!",
}

DELETE Order

This API will delete the order of the given Order Id. It requires Authentication token in the request header that could be taken using the /auth API.

curl --location --request DELETE 'http://localhost:3004/deleteOrder/1' \
--header 'Authorization: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VybmFtZSI6ImFkbWluIiwiaWF0IjoxNzI1MzU1MTM0LCJleHAiOjE3MjUzNTg3MzR9.URm8jqhNUPhXjbcDzrbWp7K9RK8boZw-4s1WTtGgnI0'

Expected Response

Status Code : 204

No Response Body will be generated

Validations

  1. Any valid Order id can be deleted.
  2. If Order Id does not exists, then status code - 404 should be displayed with following message in the response
{
    "message": "Order not found!"
}
  1. If Authentication token is not provided, then status code - 403 should be displayed with the following message in response:
{
"message": "Forbidden! Token is missing!",
}
  1. If token validation fails, then status code - 404 should be displayed with the following message in response:
{
  "message": "No Order found with the given Order Id!!",
}

Create Token

This API will create a fresh token using the following credentials that needs to be supplied in the payload:

{
    "username": "admin",
    "password": "secretPass123"
}

curl --location 'http://localhost:3004/auth' \
--header 'Content-Type: application/json' \
--data '{"username": "admin", "password": "secretPass123"}'

Expected Response

Status Code : 201

Body

{
    "message": "Authentication Successful!",
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VybmFtZSI6ImFkbWluIiwiaWF0IjoxNzI1MzQyOTAwLCJleHAiOjE3MjUzNDY1MDB9.H5NrylQbqu3TAnqRNCOUE1pG25viLMmyfBf7gTVet-g"
}

Validations

  1. username and password are mandatory fields in the request payload.
  2. If username or password fields are not supplied, then status code - 400 should be displayed with the following message:
{
    "message": "Username and Password is required for authentication!"
}
  1. If username and password does not match, authentication will fail with status code - 401 and following message
{
 "message": "Authentication Failed! Invalid username or password!"
}
Clone this wiki locally