Review Rating API

This documentation provides comprehensive details for the Review Rating API endpoints. The API supports creating, retrieving, updating, and deleting product reviews and ratings within the platform. Reviews are associated with specific products and users, enabling a complete feedback system for e-commerce platforms.

Base URL: http://localhost:8080

Authentication

All Review Rating endpoints require Bearer token authentication. Include the access token in the Authorization header:

Authorization: Bearer <your_access_token>

Review Rating Endpoints

Method	Endpoint	Description	Authentication Required
GET	/review-rating	Retrieve product reviews	Yes
POST	/review-rating	Create a new review	Yes
PUT	/review-rating/{id}	Update an existing review	Yes
DELETE	/review-rating/{id}	Delete a review	Yes

---

Endpoint Details

1. Get Reviews

GET /review-rating

Retrieve reviews for a specific product with optional pagination support.

Query Parameters

Parameter	Type	Required	Description
productId	string	Yes	UUID of the product to get reviews for
limit	number	No	Maximum number of reviews to return (default: 20)
offset	number	No	Number of reviews to skip for pagination (default: 0)

Headers

Header	Value	Required
Authorization	Bearer <access_token>	Yes

Example Request

curl -X 'GET' \
  'http://localhost:8080/review-rating?productId=cbd630f6-bf9f-48ad-ac51-f806807d99fd&limit=10' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9...'

Example Response

{
  "data": [
    {
      "id": "70ac842b-7a81-4976-9564-d440880d1736",
      "userId": "a67fd0cc-3d92-4259-bbd4-1e0ba49dece4",
      "productId": "cbd630f6-bf9f-48ad-ac51-f806807d99fd",
      "reviewText": "Good product",
      "rating": 2
    }
  ],
  "metadata": {
    "totalCount": 1,
    "limit": 10,
    "skip": 0
  }
}

Response Fields

Field	Type	Description
data	array	Array of review objects
data[].id	string	Unique identifier for the review
data[].userId	string	UUID of the user who created the review
data[].productId	string	UUID of the reviewed product
data[].reviewText	string	Text content of the review
data[].rating	number	Numerical rating (typically 1-5)

---

2. Create Review

POST /review-rating

Create a new review and rating for a product. The review will be associated with the authenticated user and specified product.

Request Body

Field	Type	Required	Description
productId	string	Yes	UUID of the product being reviewed
rating	number	Yes	Numerical rating for the product
reviewText	string	Yes	Text content of the review

Headers

Header	Value	Required
Authorization	Bearer <access_token>	Yes
Content-Type	application/json	Yes

Example Request

curl -X 'POST' \
  'http://localhost:8080/review-rating' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9...' \
  -H 'Content-Type: application/json' \
  -d '{
  "productId": "cbd630f6-bf9f-48ad-ac51-f806807d99fd",
  "rating": 2,
  "reviewText": "Good product"
}'

Example Response

{
    "id": "70ac842b-7a81-4976-9564-d440880d1736",
    "userId": "a67fd0cc-3d92-4259-bbd4-1e0ba49dece4",
    "productId": "cbd630f6-bf9f-48ad-ac51-f806807d99fd",
    "reviewText": "Good product",
    "rating": 2
  }
}

Response Fields

Field	Type	Description
id	string	Unique identifier for the created review
userId	string	UUID of the user who created the review
productId	string	UUID of the reviewed product
reviewText	string	Text content of the review
rating	number	Numerical rating for the product

---

3. Update Review

PUT /review-rating/{id}

Update an existing review by its ID. You can modify both the review text and rating.

Path Parameters

Parameter	Type	Required	Description
id	string	Yes	Unique identifier of the review to update

Query Parameters

Parameter	Type	Required	Description
review	string	No	Updated review text content
rating	number	No	Updated numerical rating

Headers

Header	Value	Required
Authorization	Bearer <access_token>	Yes

Example Request

curl -X 'PUT' \
  'http://localhost:8080/review-rating/70ac842b-7a81-4976-9564-d440880d1736?review=Product%20review%20edited&rating=5' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9...'

Example Response

{
    "id": "70ac842b-7a81-4976-9564-d440880d1736",
    "userId": "a67fd0cc-3d92-4259-bbd4-1e0ba49dece4",
    "productId": "cbd630f6-bf9f-48ad-ac51-f806807d99fd",
    "reviewText": "Product review edited",
    "rating": 5
  }
}

Response Fields

Field	Type	Description
id	string	Unique identifier of the updated review
userId	string	UUID of the user who created the review
productId	string	UUID of the reviewed product
reviewText	string	Updated review text content
rating	number	Updated numerical rating

---

4. Delete Review

DELETE /review-rating/{id}

Delete a review by its ID. This operation permanently removes the review from the system.

Path Parameters

Parameter	Type	Required	Description
id	string	Yes	Unique identifier of the review to delete

Headers

Header	Value	Required
Authorization	Bearer <access_token>	Yes

Example Request

curl -X 'DELETE' \
  'http://localhost:8080/review-rating/70ac842b-7a81-4976-9564-d440880d1736' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9...'

Example Response

"70ac842b-7a81-4976-9564-d440880d1736"

Response Fields

Field	Type	Description
data	string	ID of the deleted review

---

Error Handling

This API follows industry-standard error handling patterns (Stripe, GitHub, OpenAI):

Success Responses

• HTTP status code indicates success (200, 201, 204)
• Response body contains data directly (no wrapper object)
• No isSuccess or statusCode fields needed

Error Responses

Standard Error (400/401/403/404/500):

{
  "message": "Error description"
}

Validation Error (400):

{
  "message": "Validation failed",
  "errors": [
    {"field": "email", "message": "Invalid email format"},
    {"field": "password", "message": "Password must be at least 8 characters"}
  ]
}

Common Error Codes

Status Code	Description	Example Message
400	Bad Request	"Invalid email or password"
401	Unauthorized	"Authentication required"
403	Forbidden	"Insufficient permissions"
404	Not Found	"Product not found"
409	Conflict	"User already exists with this email"
500	Internal Server Error	"Internal server error"

All error messages are centralized and consistent across all endpoints.

---