knowledge-base-api

Prerequisites

Before you can use this project, make sure you have the following software installed on your development machine:

• Java Development Kit (JDK) 17 or later
• Apache Maven 3.8.4 or later
• Docker

GraphQL Playground

GraphQL Playground is accessible at /graphiql url :

http://localhost:8080/graphiql

Running the application in dev mode

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

./mvnw 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.jar.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 -Dnative

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

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

You can then execute your native executable with: ./target/knowledge-base-api-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

• Flyway (guide): Handle your database schema migrations
• JDBC Driver - PostgreSQL (guide): Connect to the PostgreSQL database via JDBC
• SmallRye GraphQL (guide): Create GraphQL Endpoints using the code-first approach from MicroProfile GraphQL

Provided Code

SmallRye GraphQL

Start coding with this Hello GraphQL Query

Related guide section...