[FEAT] : API Endpoint To Retrieve Product Categories

[Arnthorny]

Description

Create an API endpoint that allows an authenticated user retrieve all product categories thus providing essential information for product navigation and filtering.

This endpoint will validate the user and then return all product categories stored in the database.

Acceptance Criteria

• The endpoint allows an authenticated user retrieve a list of all product categories.
• Returns a 200 status code and the correct response body when the data is successfully retrieved.
• Returns a 401 status code when the user is not authenticated
• Returns a 500 status code when a server error occurs

Requirements

• Implement API endpoint for retrieving product categories.
• Ensure response is properly structured.
• Handle unexpected errors and return the appropriate status code.

Expected Outcome

• Users should be able to send a request to the backend to retrieve all the product categories.

Endpoints

[GET] /api/v1/products/categories

• Description: Get All Product Categories.

Responses

• Success Response:

  • Status: 200 OK
  • Body:

{
  "success": true,
  "message": "Categories retrieved successfully",
  "status_code": 200,
  "data": [
     {
     "name": "Category_1",
     "id": "id_1",
   },
    {
     "name": "Category_2",
     "id": "id_2",
   }
  ]
}

• Unauthorized Response:

  • Status: 401 Unauthenticated
  • Body:

{
  "success": false,
  "message": "Not authenticated",
  "status_code": 401
}

• Server Error Response:

  • Status: 500 Server Error
  • Body:

{
  "success": false,
  "message": "<string>",
  "status_code": 500
}

Test Scenarios

1. Successful Retrieval of Product Categories

   • Ensure that the endpoint successfully retrieves all categories in the database.
   • Confirm that the status code is 200.
   • Verify that the response body contains the retrieved data.

2. Unauthenticated Request

   • Send a request without being authenticated.
   • Verify that the endpoint returns a 401 Unauthenticated status code.

[Arnthorny]

Referred from the main Boilerplate repo https://github.com/hngprojects/hng_boilerplate_nestjs/issues/257