Quarkus Cheat Sheet
|
This section documents Quarkus 3.39.x (current) with 3.33.x LTS as the production recommendation, on the Java 17+ baseline, as published at the official Quarkus guides — which are the reference these pages are written and verified against. Quarkus 4 raises the baseline to Java 21 (first release candidate planned for end of September 2026, see the Quarkus blog); readers upgrading past 3.39.x/3.33.x LTS should expect that change. This content was generated with the assistance of AI and should be verified against those official guides before being relied on in production. This section’s bibliography lists the reference material consulted while preparing these pages. |
A single-page, colour-coded summary of the Quarkus essentials — the CLI/Maven/Gradle command table and
dev-mode key bindings, the generated project layout, the CDI (ArC) scope/producer/qualifier/interceptor/
lifecycle-event table, configuration precedence with the @ConfigMapping skeleton and the build-time-vs-runtime
distinction, Quarkus REST annotations with a minimal resource and the REST-client skeleton, Panache
active-record and repository one-liners with the query/pagination/sorting cheat rows, the @Transactional
rules, the Mutiny Uni/Multi operator table, @RunOnVirtualThread, the Reactive Messaging
@Incoming/@Outgoing/Emitter syntax, the fault-tolerance annotation table with default values, the
security-annotation and quarkus.http.auth.permission. rows with the OIDC web-app/service config two-liner,
the /q/ endpoint list, the testing annotation table, the Dev Services support matrix, the packaging/native
property table, the container-image and Kubernetes property rows, the Qute syntax mini-table, and a
Spring-to-Quarkus annotation mapping strip — handy for quick memorization or as a printable desk reference.
For the full explanation, every parameter, and additional examples, see the dedicated pages:
Foundations — Getting Started, Build-Time Augmentation and the Closed World, Extensions and the Platform, CDI and the Programming Model (ArC), Configuration, and Developer Experience.
REST, web and APIs — Quarkus REST, The MicroProfile REST Client, OpenAPI and Swagger UI, GraphQL with SmallRye, gRPC, WebSockets Next, Qute Templating, and Reactive Routes and the Vert.x HTTP Layer.
Data — Datasources and Transactions, Hibernate ORM in Quarkus, Panache: The Quarkus Data API, Reactive Data Access, NoSQL and Other Stores, Database Migrations, The Quarkus Cache Extension, and Validation with Hibernate Validator.
Reactive, concurrency and messaging — Reactive Programming and Mutiny, Virtual Threads in Quarkus, and Messaging with SmallRye Reactive Messaging.
Security — Security Overview and Architecture, Authentication Mechanisms and Identity Stores, JWT, OIDC and Keycloak, and Secrets, TLS and Hardening.
Observability and resilience — Observability: Health, Logging, Metrics, Tracing and Fault Tolerance and Resilience.
Testing — Testing Quarkus Applications.
Packaging, native images and deployment — Packaging and JVM Modes, Native Executables with GraalVM/Mandrel, Container Images, Kubernetes and OpenShift, Serverless and Cloud Functions, Command Mode and CLI Applications, and Scheduling and Mail.
Advanced — Writing Extensions, Spring API Compatibility Extensions, Build Tooling and Language Support, Performance and Tuning, and Java or Kotlin for Quarkus?.
Comparison — Quarkus vs. Spring Boot.