[FEAT] List products

[Uthmanduro]

Description

Develop an API endpoint to list products with pagination support. The endpoint should return basic information about each product, including the product name, price, and category.

Acceptance Criteria

1. API Endpoint: Create an endpoint /api/products.
2. Response Structure: The response should include:

• Product name
• Product price
• Product category

3. Pagination Support: Include pagination parameters in the request:

   • page: Current page number (default is 1)
   • limit: Number of products per page (default is 10)

4. Response Pagination Info: Include pagination information in the response:

• totalItems: Total number of products
• totalPages: Total number of pages
• currentPage: Current page number

Purpose

To provide a means for clients to retrieve a paginated list of products with essential details, enhancing the user experience by allowing them to browse products efficiently.

Requirements

• Database Integration: Ensure the endpoint queries the database to fetch product details.
• Pagination Logic: Implement logic to handle pagination, calculating the appropriate offset and limit based on the request parameters.
• Error Handling: Include proper error handling for scenarios such as invalid page/limit values and database connectivity issues.
• Testing: Write unit and integration tests to ensure the endpoint works as expected.

Request example

GET /api/v1/products?page=1&limit=10

Expected Outcome

• Response(success):

  {
  "success": true,
  "message": "Product retrieved successfully",
  "products": [
  {
    "name": "Product 1",
    "price": 29.99,
    "category": "Electronics"
  },
  {
    "name": "Product 2",
    "price": 19.99,
    "category": "Books"
  },
  ...
  ],
  "pagination": {
  "totalItems": 100,
  "totalPages": 10,
  "currentPage": 1
  },
  "status_code": 200
  } 

• Response(bad request):

  {
  "status": "bad request",
  "message": "Invalid query params passed",
  "status_code": 400
  } 

• Response(Error):

  {
  "status": "error",
  "message": "Internal server error",
  "status_code": 500
  }

  Additional Notes:

• The endpoint should be secured and require appropriate authentication/authorization.
• Ensure the API follows RESTful conventions.
• Use appropriate HTTP status codes for success and error scenarios.

  Testing

• Test that the endpoint returns a 200 on successful product retrieval.
• Test that invalid data triggers a 400 Bad Request response with an appropriate error message.
• Test that the returned product lists are within specified page and limits.
• Test that the endpoint triggers a 500 Internal server error on failed attempt to access the database

[theijhay]

This is a duplicated issue already and it's not following the RESTFUL Api rules GET /api/products?page=1&limit=10

[Uthmanduro]

Link to the approved issue is here

@theijhay Did you read what this endpoint is doing at all? PS: its different from yours

[theijhay]

Then the version your api also. buka said it on the issue ticket