Markdown-API

RobertMPollum.website Java API

markdown-api

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 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/markdown-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

• Messaging (guide): Produce and consume messages and implement event driven and data streaming applications
• REST (guide): A Jakarta REST implementation utilizing build time processing and Vert.x. This extension is not compatible with the quarkus-resteasy extension, or any of the extensions that depend on it.
• SmallRye OpenAPI (guide): Document your REST APIs with OpenAPI - comes with Swagger UI
• REST Jackson (guide): Jackson serialization support for Quarkus REST. This extension is not compatible with the quarkus-resteasy extension, or any of the extensions that depend on it
• YAML Configuration (guide): Use YAML to configure your Quarkus application
• Roq FrontMatter (guide): Create a website from your Markdown/Asciidoc/Html pages using FrontMatter headers (url, layout, seo, data).
• Hibernate Search ORM + Elasticsearch (guide): Automatically index your Hibernate entities in Elasticsearch
• REST resources for Hibernate Reactive with Panache (guide): Generate Jakarta REST resources for your Hibernate Reactive Panache entities and repositories
• Reactive PostgreSQL client (guide): Connect to the PostgreSQL database using the reactive pattern

Provided Code

YAML Config

Configure your application with YAML

Related guide section...

The Quarkus application configuration is located in src/main/resources/application.yml.

REST

Easily start your REST Web Services

Related guide section...