Catalog Service

The catalog-service manages the books catalog and exposes the following REST API endpoints:

• Get books by page
• Get book by code(ISBN)
• Create new Book
• Update existing book
• Delete a book
• Search books by title or description

API Endpoints

1. Get books by page

• Endpoint : GET /api/products?page=1
• Security: N/A
• Response:

{
   "totalElements": 124,
   "totalPages": 13,
   "currentPage": 1,
   "data": [
      {
          "id": "uuid",
          "code": "ABCDEFGH",
          "name": "Book Title",
          "description": "book description",
          "image_url": "https://images.com/1.png",
          "price": 24.50,
          "discount": 1.50,
          "salePrice": 23.0
      }
   ]
}

2. Get book by code(ISBN)

• Endpoint : GET /api/products/{code}
• Security: N/A
• Success Response:

{
  "id": "uuid",
  "code": "ABCDEFGH",
  "name": "Book Title",
  "description": "book description",
  "image_url": "https://images.com/1.png",
  "price": 24.50,
  "discount": 1.50,
  "salePrice": 23.0
}

• Error Response - Status Code: 404 - Not Found

  {
      "message": "Product with code <ISBN> not found"
  } 

3. Search books by title or description

• Endpoint : GET /api/products/search?query=keyword&page=1
• Security: N/A
• Response:

{
   "totalElements": 114,
   "totalPages": 12,
   "currentPage": 1,
   "data": [
      {
          "id": "uuid",
          "code": "ABCDEFGH",
          "name": "Book Title",
          "description": "book description",
          "image_url": "https://images.com/1.png",
          "price": 24.50,
          "discount": 1.50,
          "salePrice": 23.0
      }
   ]
}

4. Create new Book

• Endpoint : POST /api/products
• Security: Header Authorization: Bearer <JWT_TOKEN> with Role ADMIN or STAFF
• Request Body:

{
  "code": "ABCDEFGH", // unique
  "name": "Book Title", // mandatory
  "description": "book description", // optional
  "image_url": "https://images.com/1.png",// optional
  "price": 24.50 // mandatory
  "discount": 2.50 // optional
}

• Success Response: Status Code: 201

{
  "id": "uuid",
  "code": "ABCDEFGH",
  "name": "Book Title",
  "description": "book description",
  "image_url": "https://images.com/1.png",
  "price": 24.50,
  "discount": 2.50,
  "salePrice": 22.0
}

• Error Response - Bad Request - Status Code: 400
  • Reasons: Missing required fields, Book with ISBN already exist etc.

  {
      "message": "Product with ISBN already exist"
  } 

5. Update existing book

• Endpoint : PUT /api/products/{code}
• Security: Header Authorization: Bearer <JWT_TOKEN> with Role ADMIN or STAFF
• Request Body:

{
  "name": "Book Title", // mandatory
  "description": "book description", // optional
  "image_url": "https://images.com/1.png", // optional
  "price": 24.50, // mandatory
  "discount": 2.50
}

• Success Response:
  • Status Code: 200
  • Body:

{
  "id": "uuid",
  "code": "ISBN",
  "name": "Book Title",
  "description": "book description",
  "image_url": "https://images.com/1.png",
  "price": 24.50,
  "discount": 2.50,
  "salePrice": 22.0
}

• Error Response - Bad Request
  • Reasons: Missing required fields, Book with ISBN not exist etc.
  • Status Code: 400
  • Body:

  {
      "message": "Product with ISBN not exist"
  } 

6. Delete a book

• Endpoint : DELETE /api/products/{code}
• Security: Header Authorization: Bearer <JWT_TOKEN> with Role ADMIN or STAFF
• Success Response:
  • Status Code: 200
• Error Response - Not Found
  • Reasons: Book with ISBN not exist etc.
  • Status Code: 404
  • Body:

  {
      "message": "Product with ISBN not exist"
  }