/java-rest-api-examples

Java REST API Examples

Primary LanguageHTMLApache License 2.0Apache-2.0

Java REST API Examples: Micronaut, Quarkus, Spring Boot, and Helidon

This repository contains example OAuth 2.0 resource servers built with imperative and reactive versions of Micronaut, Quarkus, Spring Boot, and Helidon. See the imperative and reactive demo scripts to see how these examples were created.

Prerequisites: Java 21 with GraalVM and HTTPie.

Events:

Tip

See releases for the code from a specific event.

Getting Started

Click the button below to start a new Gitpod development environment with this project:

Open in Gitpod

Or, if you'd rather try things locally, clone this repository:

git clone https://github.com/mraible/java-rest-api-examples.git

You will need a JDK with GraalVM and its native-image compiler. Using SDKMAN, run the following command and set it as the default:

sdk install java 21.0.2-graalce

Next, you'll need a free Auth0 developer account.

Install the Auth0 CLI and run auth0 login to connect it to your account.

Create an access token using Auth0's CLI:

auth0 test token -a https://<your-auth0-domain>/api/v2/ -s openid

Set the access token as a TOKEN environment variable in a terminal window.

TOKEN=eyJraWQiOiJYa2pXdjMzTDRBYU1ZSzNGM...

Change the following files for each framework to match your Auth0 domain:

  • Micronaut: micronaut/src/main/resources/application.properties
  • Quarkus: quarkus/src/main/resources/application.properties
  • Spring Boot: spring-boot/src/main/resources/application.properties
  • Helidon: helidon/src/main/resources/application.properties

You can start each app using its CLI, Gradle, or Maven. Note that you will only be able to start one at a time since they all run on port 8080.

  • Micronaut: ./gradlew run
  • Quarkus: quarkus dev
  • Spring Boot: ./gradlew bootRun
  • Helidon: helidon dev

Then, you can test them with an access token and HTTPie.

Use HTTPie to pass the JWT in as a bearer token in the Authorization header.

http :8080/hello Authorization:"Bearer $TOKEN"

You should see your email address printed to your terminal.

You can also build and run each example as a native app.

  • Micronaut: ./gradlew nativeCompile
  • Quarkus: quarkus build --native
  • Spring Boot: ./gradlew nativeCompile
  • Helidon: mvn package -Pnative-image

Then, start each app as a native executable.

  • Micronaut: ./build/native/nativeCompile/app
  • Quarkus: ./build/quarkus-1.0.0-SNAPSHOT-runner
  • Spring Boot: ./build/native/nativeCompile/spring-boot
  • Helidon: ./target/helidon

Links

This example uses the following open source libraries:

Help

Please post any questions as issues in this repo or start a discussion.

License

Apache 2.0, see LICENSE.