Skip to content

Latest commit

 

History

History
115 lines (95 loc) · 3.94 KB

README.md

File metadata and controls

115 lines (95 loc) · 3.94 KB
Raw

quarkus-api-template

This project aims to be a baseline for REST microservices development based on the Quarkus Frameworks. It is a commodity repository meant to be cloned and adapted later to any further use, this template ships with the features I require most during my everyday development activity such as:

  • OpenAPI 3.0 swagger generation
  • Exception handling
  • REST APIs
  • ...more to come

Adaptation

Refactoring

After cloning this repository you might want to customize it for your needs. Inside your pom.xml you may edit the groudId and the artifactId

<groupId>it.template</groupId>
<artifactId>quarkus-api-template</artifactId>
<version>1.0.0-SNAPSHOT</version>

After that, by using a IDE of your choice, you may refactor the it.template package name to your groupId.

Modifying the swagger/openapi properties

You may find a handful of properties that are ready to be edited inside application.properties

##  SWAGGER PROPERTIES
quarkus.smallrye-openapi.info-version=1.0.1
quarkus.smallrye-openapi.info-description=Just an example service
quarkus.smallrye-openapi.info-terms-of-service=Your terms here
quarkus.smallrye-openapi.info-contact-email=techsupport@example.com
quarkus.smallrye-openapi.info-contact-name=Quarkus REST Template Support
quarkus.smallrye-openapi.info-contact-url=http://exampleurl.com/contact
quarkus.smallrye-openapi.info-license-name=Apache 2.0
quarkus.smallrye-openapi.info-license-url=https://www.apache.org/licenses/LICENSE-2.0.html

Extending the Exception handling logic

The Exception handling logic is nested inside the ExceptionHandler.java file. It is built to catch Subclasses of the object ApiException and to return a response body that looks like

{
    "errorCode": "HTTP_400",
    "errorCodeDescription": "BAD_REQUEST",
    "errorMessage": "Testing BAD_REQUEST",
    "exception": null
}

You can customize and create new Exception classes by:

  1. Creating a specific ErrorCode enum inside the ErrorCode.java class
public enum ErrorCode {
    HTTP_400("BAD_REQUEST"),
    HTTP_500("INTERNAL_SERVER_ERROR");
    ...
}
  1. Creating a new class that extends the APIException class, and build the ExceptionResponse accordingly with the given ErrorCodes
public BadRequestException() {
    super();
    ErrorCode error = ErrorCode.HTTP_400;
    ExceptionResponse response = new ExceptionResponse(error, error.getDescription(), null);
    this.setResponse(response);
}

public BadRequestException(String message) {
    super();
    ErrorCode error = ErrorCode.HTTP_400;
    ExceptionResponse response = new ExceptionResponse(error, error.getDescription(), null);
    this.setResponse(response);
    response.setErrorMessage(message);
}
  1. Adding a case switch for your specific ErrorCode inside the ExceptionHandler class, for each error code you may decide which http code has to be returned to the client by setting the related Response.Status object
switch (e.getResponse().getErrorCode()) {
            case HTTP_400: {
                return Response.status(Response.Status.BAD_REQUEST)
                               .entity(
                                    new ExceptionResponse(
                                        e.getResponse().getErrorCode(),
                                        e.getResponse().getErrorMessage(),
                                        null))
                                .build();
}
case ...

OpenAPI 3.0 and Swagger-ui

You may access the generated swagger in both yaml and json format through these endpoints

  • /q/openapi
  • /q/openapi?format=json

Swagger-UI is available at:

  • /q/swagger-ui

Building and running Docker image

Prerequisites:

  • GraalVM 22.2.0
  • Quarkus toolchain
  • Docker
quarkus build --native --no-tests -D quarkus.native.container-build=true
docker build -f src/main/docker/Dockerfile.native-micro -t quarkus/quarkus-api-template .
docker run -i --rm -p 8080:8080 quarkus/quarkus-api-template