The User Service is a key component in our microservice architecture. It is responsible for managing user data and provides functionalities for creating, updating, deleting, and retrieving user information. In addition to these basic CRUD operations, the User Service also manages user reviews for restaurants. Each review includes a score between 1 and 5. The User Service enhances the user experience by allowing users to share their opinions and experiences about restaurants.
The RestaurantClient is a Feign client in the User Service. Feign is a declarative web service client that makes writing HTTP clients easier. In our microservice architecture, it is used to communicate between services.
In this case, the RestaurantClient is used to communicate with the Restaurant Service. It has two main operations:
-
getAllRestaurants(): This operation fetches all restaurants from the Restaurant Service. It corresponds to aGET /api/v1/restaurantsrequest to the Restaurant Service. -
getRestaurantById(String id): This operation fetches a specific restaurant by its ID from the Restaurant Service. It corresponds to aGET /api/v1/restaurants/{id}request to the Restaurant Service.
These operations are crucial for the User Service to manage user reviews for restaurants. When a user wants to review a restaurant, the User Service uses the RestaurantClient to fetch the details of the restaurant from the Restaurant Service. This ensures that users can only review existing restaurants and allows the User Service to display up-to-date information about the restaurants being reviewed.
The UserController is a REST controller that provides endpoints for managing user data.
-
GET /api/v1/users: This endpoint returns all users in the database. -
GET /api/v1/users/{id}: This endpoint returns a user by its ID. -
POST /api/v1/users: This endpoint saves a new user to the database. It accepts aUserSaveRequestobject in the request body. -
PUT /api/v1/users/{debugId}: This endpoint updates an existing user in the database. It accepts aUserUpdateRequestobject in the request body. -
DELETE /api/v1/users/{id}: This endpoint deletes a user from the database by its ID.
The responses from these endpoints are wrapped in a RestResponse object. This object contains the following fields:
-
data: The data of the response. It can be aUserDTOobject, a list ofUserDTOobjects, ornullin the case of a delete operation. -
message: A message describing the result of the operation.
The UserDTO object represents a user and contains the following fields:
id: The ID of the user.name: The name of the user.email: The email of the user.latitude: The latitude of the user's location.longitude: The longitude of the user's location.
The UserReviewController is a REST controller that provides endpoints for managing user reviews.
-
GET /api/v1/users/reviews/{id}: This endpoint returns a user review by its ID. -
POST /api/v1/users/reviews: This endpoint creates a new user review. It accepts aUserReviewSaveRequestobject in the request body. -
GET /api/v1/users/reviews/all: This endpoint returns all user reviews. -
GET /api/v1/users/reviews/user/{userId}: This endpoint returns user reviews by user ID. -
GET /api/v1/users/reviews/restaurant/{restaurantId}: This endpoint returns user reviews by restaurant ID. -
PUT /api/v1/users/reviews: This endpoint edits a user review. It accepts aUserReviewUpdateRequestobject in the request body. -
DELETE /api/v1/users/reviews/{id}: This endpoint deletes a user review by its ID.
The responses from these endpoints are wrapped in a RestResponse object. This object contains the following fields:
-
data: The data of the response. It can be aUserReviewDetailDTOobject, a list ofUserReviewDetailDTOobjects, ornullin the case of a delete operation. -
message: A message describing the result of the operation.
The UserReviewDetailDTO object represents a user review and contains the following fields:
id: The ID of the user review.userId: The ID of the user who made the review.restaurantId: The ID of the restaurant that was reviewed.score: The score given by the user.text: The text of the review.
Unit and integration tests are provided for the User Service. These tests ensure that the service functions as expected when interacting with the database and handling HTTP requests.
