Skip to content

RESTful API built with Quarkus and PostgreSQL. Supersonic Subatomic Java.

Notifications You must be signed in to change notification settings

jeanpierm/rest-api-quarkus-postgresql

Repository files navigation

Quarkus RESTful API - Example

Docker compose

Run:

# run containers
docker compose up -d

# see logs
docker compose logs -f

swagger-ui

Swagger OpenAPI

Visit http://localhost:8080/q/swagger-ui/

swagger-ui

This project uses Quarkus, the Supersonic Subatomic Java Framework.

If you want to learn more about Quarkus, please visit its website: https://quarkus.io/ .

Running the application in dev mode

You can run your application in dev mode that enables live coding using:

./mvnw compile quarkus:dev

NOTE: Quarkus now ships with a Dev UI, which is available in dev mode only at http://localhost:8080/q/dev/.

Packaging and running the application

The application can be packaged using:

./mvnw package

It produces the quarkus-run.jar file in the target/quarkus-app/ directory. Be aware that it’s not an über-jar as the dependencies are copied into the target/quarkus-app/lib/ directory.

The application is now runnable using java -jar target/quarkus-app/quarkus-run.jar.

If you want to build an über-jar, execute the following command:

./mvnw package -Dquarkus.package.type=uber-jar

The application, packaged as an über-jar, is now runnable using java -jar target/*-runner.jar.

Creating a native executable

You can create a native executable using:

./mvnw package -Pnative

Or, if you don't have GraalVM installed, you can run the native executable build in a container using:

./mvnw package -Pnative -Dquarkus.native.container-build=true

You can then execute your native executable with: ./target/hello-1.0.0-SNAPSHOT-runner

If you want to learn more about building native executables, please consult https://quarkus.io/guides/maven-tooling.

Related Guides

  • RESTEasy JAX-RS (guide): REST endpoint framework implementing JAX-RS and more

Provided Code

RESTEasy JAX-RS

Easily start your RESTful Web Services

Related guide section...

About

RESTful API built with Quarkus and PostgreSQL. Supersonic Subatomic Java.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published