This project showcases the development of a RESTful web service using JAX-RS and Java EE 8. It implements RESTful endpoints with Jersey, ensures robust input validation through the Jakarta Bean Validation API, and features custom error handling for improved user feedback. Detailed logging is achieved with Log4j2, while dependency injection is seamlessly integrated using Weld. Furthermore, the project includes comprehensive API documentation powered by Swagger.
The project includes:
- Creation of RESTful endpoints using Jersey (JAX-RS implementation).
- Validation of input data using Jakarta Bean Validation API.
- Handling of various exceptions and return of appropriate HTTP statuses with Jersey.
- Logging of request and response details using Log4j2.
- CDI integration for dependency injection using Weld (Jakarta CDI implementation).
- Documentation for API endpoints and usage examples using Swagger.
- Java 8 or higher
- Maven
Clone the repository:
git clone https://github.com/your-username/learning-jax-rs.git
cd learning-jax-rsBuild the project using Maven:
mvn clean installYou can run the application using the following command:
mvn jetty:runThe application will be available at http://localhost:8080/api.
The domain package contains the classes representing the requests and responses for operations. The key classes include:
OperationRequest: Represents a request for a mathematical operation.OperationResponse: Represents the response for a mathematical operation.
The resources package contains the RESTful services. The key class is:
MathOperationResource: Provides endpoints to perform mathematical operations.
The configuration class initializes the JAX-RS application:
RestResourceConfig: Configures the application by specifying the package to scan for resources and settings for bean validation.
The exception package contains custom exception mappers to handle various exceptions and return appropriate responses:
ArithmeticExceptionMapperNullPointerExceptionMapperConstraintViolationExceptionMapper
Logging is configured using Log4j2, and the configuration is provided in log4j2.xml. The log messages are color-coded
for different logging levels.
The request should be a JSON object containing firstNumber, secondNumber, and operation:
{
"firstNumber": 10,
"secondNumber": 5,
"operation": "ADD"
}The response will be a JSON object indicating success or failure and the result:
{
"isError": false,
"message": "Success",
"result": 15
}Contributions are welcome! Please fork the repository and create a pull request with your changes.
This project is licensed under the MIT License - see the LICENSE file for details.