Guides - Latest
Tutoriales
Ejercicios cortos y enfocados para que te pongas en marcha rápidamente.
Collect metrics using Micrometer
Create an application that uses the Micrometer metrics library to collect runtime, extension and application metrics and expose them as a Prometheus (OpenMetrics) endpoint.
Creating Your First Application
Discover how to create your first Quarkus application.
Creating a tutorial
Create a new tutorial that guides users through creating, running, and testing a Quarkus application that uses annotations from an imaginary extension.
Getting Started With Reactive
Learn more about developing reactive applications with Quarkus.
Secure a Quarkus application with Basic authentication
Secure your Quarkus application endpoints by combining Quarkus built-in basic HTTP authentication with the JPA identity provider to enable role-based access control (RBAC).
Using our Tooling
Explore the Quarkus developer toolchain which makes Quarkus development so fast and enjoyable.
Guías prácticas
Guías paso a paso para cubrir tareas clave, operaciones del mundo real y problemas comunes.
Contribute to Quarkus documentation
Contribute to the documentation by using the recommended steps, workflow, and style guidance to ensure the content successfully renders on the Quarkus website portal.
Enable Basic authentication
Enable Basic authentication for your Quarkus project and allow users to authenticate with a username and password.
Conceptos
Explicaciones de algunos de los conceptos y tecnologías más importantes relacionados con Quarkus.
Basic Authentication
HTTP Basic Authentication is one of the least resource-demanding techniques that enforce access controls to the Web resources.
Built-In Authentication Support
The following section describes the Quarkus built-in authentication mechanisms for HTTP based FORM, BASIC, and Mutual TLS authentication.
Quarkus Security overview
Quarkus Security is a framework that provides the architecture, multiple authentication and authorization mechanisms, and other tools for you to build secure and production-quality Java applications.
Quarkus documentation content types
Quarkus documentation is structured into four distinct content types: concepts, how-tos, tutorials, and references.
Referencias
Recurso técnico que cubre herramientas, componentes y comandos. La enciclopedia de Quarkus.
Quarkus Cheat Sheet
Command Mode Applications
This reference guide explains how to develop command line applications with Quarkus.
HTTP Reference
Learn more about configuring Quarkus’ Vert.x based HTTP layer - and Undertow if you are using servlets.
Mailer Reference Guide
This reference guide explains in more details the configuration and usage of the Quarkus Mailer.
Native Reference Guide
This guide is a companion to the Building a Native Executable, Using SSL With Native Images, and Writing Native Applications, guides.
OpenID Connect (OIDC) and OAuth2 Client and Filters Reference Guide
This reference guide explains how to use:
Quarkus style and content guidelines
Guidelines are provided to help you to contribute clear and consistent content that is also sourced in the required structure and composition of Quarkus documentation.
Qute Reference Guide
Learn everything you need to know about the Qute template engine.
Reactive Messaging AMQP 1.0 Connector Reference Documentation
This guide is the companion from the Getting Started with AMQP 1.0.
Reactive Messaging RabbitMQ Connector Reference Documentation
This guide is the companion from the Getting Started with RabbitMQ.
Redis Extension Reference Guide
Redis is an in-memory data store used as a database, cache, streaming engine, and message broker.
Stork Reference Guide
This guide is the companion from the Stork Getting Started Guide.
Vert.x Reference Guide
This reference guide provides advanced details about the usage and the configuration of the Vert.x instance used by Quarkus.
Guías generales
Otras guías de Quarkus
Accessing application properties with Spring Boot properties API
Use Spring Boot’s @ConfigurationProperties
in place of MicroProfile Config annotations
Amazon Lambda SnapStart Configuration
This document explains how to optimize your AWS Lambda application for SnapStart
Amazon Lambda with RESTEasy Reactive, Undertow, or Reactive Routes
This guide explains how you can deploy Vert.x Web, Servlet, or RESTEasy microservices as an Amazon Lambda.
Apache Kafka Reference Guide
This reference guide provides an in-depth look on Apache Kafka and Smallrye Reactive Messaging framework.
Application Data Caching
This guide explains how to cache expensive method calls of your CDI beans using simple annotations.
Application Initialization and Termination
You often need to execute custom actions when the application starts and clean up everything when the application stops.
Azure Functions (Serverless) with RESTEasy Reactive, Undertow, or Reactive Routes
This guide explains how you can deploy Vert.x Web, Servlet, or RESTEasy microservices as an Azure Function.
Build Items
Explore all the BuildItems you can consume/produce in your extensions.
Build, Sign and Encrypt JSON Web Tokens
According to RFC7519, JSON Web Token (JWT) is a compact, URL-safe means of representing claims which are encoded as a JSON object that is used as the payload of a JSON Web Signature (JWS) structure or as the plaintext of a JSON Web Encryption (JWE) structure, enabling the claims to be digitally signed or integrity protected with a Message Authentication Code(MAC) and/or encrypted.
Building Quarkus apps with Gradle
This guide covers: Gradle configuration, creating a new project, dealing with extensions, development mode, debugging, import in your IDE, building a native image, and build a container friendly executable
Building Quarkus apps with Quarkus Command Line Interface (CLI)
Use the Quarkus CLI to create, build, run, and manage extensions for Quarkus projects.
Building applications with Maven
This guide covers: Maven configuration, creating a new project, dealing with extensions, development mode, debugging, import in your IDE, building a native image, and build a container friendly executable
CDI Integration Guide
Learn how to integrate your extension with Quarkus’ CDI container.
Centralized log management (Graylog, Logstash, Fluentd)
This guide explains how to centralize your logs with Logstash or Fluentd using the Graylog Extended Log Format (GELF).
Command Mode with Picocli
Simplify command line applications creation with the Picocli extension.
Compressing native executables using UPX
Ultimate Packer for eXecutables (UPX) is a compression tool reducing the size of executables.
Conditional Extension Dependencies
Trigger the inclusion on additional extensions based on certain conditions.
Configuring Your Application
Hardcoded values in your code is a no go (even if we all did it at some point ;-)).
Connecting to an Elasticsearch cluster
This guide covers how to use an Elasticsearch cluster using the low level or high level REST clients.
Consuming a gRPC Service
This guide explains how to consume gRPC services in your Quarkus application.
Container Images
Learn how to build and push container images with Jib, S2I or Docker as part of the Quarkus build.
Context Propagation in Quarkus
Learn more about how you can pass contextual information with SmallRye Context Propagation.
Cross-Site Request Forgery Prevention
Cross-Site Request Forgery (CSRF) is an attack that forces an end user to execute unwanted actions on a web application in which they are currently authenticated.
Deploying to Google Cloud Platform (GCP)
This guide explains how to deploy a Quarkus application to Google Cloud.
Deploying to Microsoft Azure Cloud
This guide explains how to deploy a Quarkus application to Microsoft Azure Cloud.
Dev Services Overview
A list of all extensions that support Dev Services and their configuration options.
Dev Services and UI for OpenID Connect (OIDC)
Start Keycloak or other providers automatically in dev and test modes.
Dev Services for Apicurio Registry
Start Apicurio Registry automatically in dev and test modes.
Dev Services for Databases
When testing or running in dev mode Quarkus can provide you with a zero-config database out of the box, a feature we refer to as Dev Services.
Dev Services for Elasticsearch
If any Elasticsearch-related extension is present (e.g.
Dev Services for Kogito
If any Kogito process-related extension is present (e.g.
Dev Services for Kubernetes
Start a Kubernetes API server automatically in dev and test modes.
Dev Services for RabbitMQ
Dev Services for RabbitMQ automatically starts a RabbitMQ broker in dev mode and when running tests.
Extension codestart
Provide users with initial code for extensions when generating Quarkus applications on code.quarkus.io and all the Quarkus tooling.
Extension for Spring Data API
While you are encouraged to use Hibernate ORM with Panache for your data layer, Quarkus provides a compatibility layer for Spring Data JPA in the form of the spring-data-jpa extension.
Extension for Spring Data REST
Spring Data REST simplifies the creation of CRUD applications based on our Spring Data compatibility layer.
Funqy
This guide explains basics of the Funqy framework, a simple portable cross-provider cloud function API.
Funqy Google Cloud Functions
This guide explains Funqy’s Google Cloud Platform Functions binding.
Funqy HTTP Binding with Azure Functions
This guide explains Funqy’s Azure Functions HTTP binding.
Funqy HTTP Binding with Google Cloud Functions
This guide explains Funqy’s Google Cloud Platform Functions HTTP binding.
Generating JAX-RS resources with Panache
Hibernate ORM REST Data with Panache simplifies the creation of CRUD applications based on JAX-RS and Hibernate ORM.
Getting Started to SmallRye Reactive Messaging with AMQP 1.0
This guide demonstrates how your Quarkus application can utilize SmallRye Reactive Messaging to interact with AMQP.
Getting Started to SmallRye Reactive Messaging with Apache Kafka
This guide demonstrates how your Quarkus application can utilize SmallRye Reactive Messaging to interact with Apache Kafka.
Getting Started to SmallRye Reactive Messaging with RabbitMQ
This guide demonstrates how your Quarkus application can utilize SmallRye Reactive Messaging to interact with RabbitMQ.
Getting Started with SmallRye Stork
The essence of distributed systems resides in the interaction between services.
Getting Started with gRPC
This guide explains how to start using gRPC in your Quarkus application.
Google Cloud Functions (Serverless)
This guide explains how you can deploy Quarkus-based Google Cloud Functions.
Google Cloud Functions (Serverless) with RESTEasy Reactive, Undertow, or Reactive Routes
This guide explains how you can deploy Vert.x Web, Servlet, or RESTEasy microservices as a Google Cloud Function.
Hibernate Search guide
Hibernate Search allows you to index your entities in an Elasticsearch cluster and easily offer full text search in all your Hibernate ORM-based applications.
How dev mode differs from a production application
How dev mode differs from a production application
Implementing a gRPC Service
This guide explains how to implement gRPC services in your Quarkus application.
Infinispan Client
Infinispan is an in memory data grid that allows running in a server outside of application processes.
Introduction to Contexts and Dependency Injection
Quarkus DI solution is based on the Contexts and Dependency Injection for Java 2.0 specification.
Kubernetes Client
This guide demonstrates how to use the Fabric8 Kubernetes client to interact with your Kubernetes cluster.
Measuring Performance
This guide explains how to best measure the footprint of a Quarkus application.
Measuring the coverage of your tests
This guide explains how to measure the test coverage of your Quarkus application.
Micrometer Metrics
This guide demonstrates how your Quarkus application can collect metrics using the Micrometer extension.
Migrating to RESTEasy Reactive
Migrating from RESTEasy Classic to RESTEasy Reactive is straightforward in most cases, however there are a few cases that require some attention.
Mutiny - Async for bare mortal
Mutiny is an intuitive, reactive programming library.
Narayana LRA Participant Support
This guides covers the usage of LRA to coordinate activities across services.
OpenID Connect (OIDC) authorization code flow mechanism
This guide demonstrates how to use the OpenID Connect Extension to protect your web application based on the Authorization Code Flow using Quarkus.
OpenID Connect Client and Token Propagation Quickstart
This guide explains how to use OpenID Connect and OAuth2 Client and Filters to acquire, refresh and propagate access tokens.
OptaPlanner - Using AI to optimize a schedule with OptaPlanner
This guide walks you through the process of creating a Quarkus application with OptaPlanner’s constraint solving Artificial Intelligence (AI).
Packaging And Releasing With JReleaser
This guide covers packaging and releasing CLI applications using the JReleaser tool.
Quarkus Base Runtime Image
To ease the containerization of native executables, Quarkus provides a base image providing the requirements to run these executables.
Quarkus Extension Metadata
Quarkus extensions are distributed as Maven JAR artifacts that application and other libraries may depend on.
Quarkus Extension Registry
Learn more about the notion of extension registry and how you can use your own.
Quarkus Extension for Spring Cache API
While you are encouraged to use the Cache extension for your application-level caching, Quarkus provides a compatibility layer for Spring Cache in the form of the spring-cache extension.
Quarkus Extension for Spring DI API
While you are encouraged to use CDI annotations for injection, Quarkus provides a compatibility layer for Spring dependency injection in the form of the spring-di extension.
Quarkus Extension for Spring Scheduling API
While you are encouraged to use the Scheduler or Quartz extensions to schedule tasks, Quarkus provides a compatibility layer for Spring Scheduled in the form of the spring-scheduled extension.
Quarkus Extension for Spring Security API
While you are encouraged to use the Quarkus security layer to secure your applications, Quarkus provides a compatibility layer for Spring Security in the form of the spring-security extension.
Quarkus Extension for Spring Web API
While you are encouraged to use JAX-RS annotations for defining REST endpoints, Quarkus provides a compatibility layer for Spring Web in the form of the spring-web extension.
Quarkus Maven Plugin
The Quarkus Maven Plugin builds the Quarkus applications, and provides helpers to launch dev mode or build native executables.
Qute Templating Engine
Learn more about how you can use templating in your applications with the Qute template engine.
Re-augment a Quarkus Application
Use mutable jars to rebuild your application with different build time configurations.
Reading properties from Spring Cloud Config Server
Quarkus provides a compatibility layer for Spring Cloud Config in the form of the spring-cloud-config-client extension.
Scheduling Periodic Tasks
Modern applications often need to run specific tasks periodically.
Scheduling Periodic Tasks with Quartz
You need clustering support for your scheduled tasks? This guide explains how to use the Quartz extension for that.
Security Testing
This document describes how to test Quarkus Security.
Sending emails using SMTP
Learn more about how you can send email from a Quarkus application with our reactive email client.
Simplified Hibernate ORM with Panache
Hibernate ORM is the de facto JPA implementation and offers you the full breadth of an Object Relational Mapper.
Simplified Hibernate ORM with Panache and Kotlin
This explains the specifics of using Hibernate ORM with Panache in a Kotlin project.
Simplified Hibernate Reactive with Panache
Simplified reactive ORM layer based on Hibernate Reactive.
Simplified MongoDB with Panache
This guide covers the usage of MongoDB using active records and repositories.
Simplified MongoDB with Panache and Kotlin
This guide covers the usage of MongoDB using active records and repositories in a Kotlin project.
SmallRye Fault Tolerance
This guide demonstrates how your Quarkus application can utilize the SmallRye Fault Tolerance specification through the SmallRye Fault Tolerance extension.
SmallRye GraphQL
This guide explains how to leverage SmallRye GraphQL to implement GraphQL services.
SmallRye GraphQL Client
This guide explains how to leverage SmallRye GraphQL Client to consume GraphQL services.
SmallRye Health
This guide demonstrates how your Quarkus application can utilize the SmallRye Health extension.
SmallRye Metrics
This guide demonstrates how your Quarkus application can utilize the SmallRye Metrics extension.
Testing Your Application
This guide covers testing in JVM mode, native mode, and injection of resources into tests
Tips for writing native applications
This guide is a collection of tips to help you solve the problems you encounter when compiling applications to native executable.
Using Apache Kafka Streams
This guide demonstrates how your Quarkus application can utilize the Apache Kafka Streams API to implement stream processing applications based on Apache Kafka.
Using Apache Kafka with Schema Registry and Avro
Use Apache Kafka, Avro serialized records, and connect to a schema registry.
Using Blaze-Persistence
This guide explains how to use Blaze-Persistence to simplify your data and DTO layers.
Using Eclipse Vert.x API from a Quarkus Application
This guide explains how to use Vert.x in Quarkus to build reactive applications.
Using Flyway
This guide covers how to use the Flyway extension to manage your schema migrations.
Using Hibernate ORM and JPA
Hibernate ORM is the de facto JPA implementation and offers you the full breath of an Object Relational Mapper.
Using Hibernate Reactive
Hibernate Reactive is a reactive API for Hibernate ORM, supporting non-blocking database drivers and a reactive style of interaction with the database.
Using JMS
This guide demonstrates how your Quarkus application can use JMS messaging with AMQP 1.0 using Apache Qpid JMS, or using Apache ActiveMQ Artemis JMS.
Using JWT RBAC
This guide explains how your application can utilize SmallRye JWT to provide secured access to the JAX-RS endpoints.
Using Keycloak Admin Client
The Quarkus Keycloak Admin Client and its reactive twin support Keycloak Admin Client which can be used to configure a running Keycloak server.
Using Kogito DMN support to add decision automation capabilities to an application
Use Kogito to add business automation and power it up with DMN decision support.
Using Kogito to add business automation capabilities to an application
This guide demonstrates how your Quarkus application can use Kogito to add business automation to power it up with business processes and rules.
Using Kogito to add prediction capabilities to an application
Use Kogito to add business automation to power it up with predictions.
Using Kogito to add rule engine capabilities to an application
Use Kogito to add DRL files with rules.
Using Liquibase
This guide covers how to use the Liquibase extension to manage your schema migrations.
Using Liquibase MongoDB
Liquibase is an open source tool for database schema change management, it allows managing MongoDB databases via it’s MongoDB Extension.
Using OAuth2 RBAC
This guide explains how your Quarkus application can utilize OAuth2 tokens to provide secured access to the JAX-RS endpoints.
Using OpenAPI and Swagger UI
This guide explains how to use the OpenAPI extension to generate an OpenAPI descriptor and get a Swagger UI frontend to test your REST endpoints.
Using OpenID Connect (OIDC) Multi-Tenancy
This guide demonstrates how your OpenID Connect application can support multi-tenancy so that you can serve multiple tenants from a single application.
Using OpenID Connect (OIDC) and Keycloak to Centralize Authorization
This guide demonstrates how your Quarkus application can authorize access to protected resources using Keycloak Authorization Services.
Using OpenID Connect (OIDC) to Protect Service Applications using Bearer Token Authorization
This guide demonstrates how your Quarkus application can use Keycloak to protect your JAX-RS applications using bearer token authorization, where these tokens are issued by a Keycloak server.
Using OpenTelemetry
This guide explains how your Quarkus application can utilize OpenTelemetry to provide distributed tracing for interactive web applications.
Using OpenTracing
This guide explains how your Quarkus application can utilize OpenTracing to provide distributed tracing for interactive web applications.
Using Podman with Quarkus
Podman is a daemonless and rootless container engine for developing, managing, and running OCI Containers on your Linux system or other OS.
Using SSL With Native Executables
In this guide, we will discuss how you can get your native images to support SSL, as native images don’t support it out of the box.
Using Security with .properties File
This guide demonstrates how your Quarkus application can use a .properties file to store your user identities.
Using Security with JDBC
This guide demonstrates how your Quarkus application can use a database to store your user identities.
Using Security with WebAuthn
This guide demonstrates how your Quarkus application can use WebAuthn authentication instead of passwords.
Using Security with an LDAP Realm
This guide demonstrates how your Quarkus application can use a LDAP directory to store your user identities.
Using Software Transactional Memory in Quarkus
This guides covers the usage of Software Transactional Memory (STM).
Using Stork with Kubernetes
This guide explains how to use Stork with Kubernetes for service discovery and load balancing.
Using Transactions in Quarkus
Quarkus comes with a Transaction Manager and uses it to coordinate and expose transactions to your applications.
Using WebSockets
This guide explains how your Quarkus application can utilize web sockets to create interactive web applications.
Using a Credentials Provider
This guides explains how to use the Vault credentials provider or implement your own custom one.
Using the Cassandra Client
This guide covers how to use the Apache Cassandra NoSQL database in Quarkus.
Using the REST Client
This guide explains how to use the RESTEasy REST Client in order to interact with REST APIs (JSON and other) with very little effort.
Using the REST Client Reactive
This guide explains how to use the RESTEasy Reactive REST Client.
Using the REST Client with Multipart
This guide explains how to use the RESTEasy REST Client to send multipart REST requests, typically to upload documents.
Using the event bus
This guide explains how different beans can interact using the event bus.
Using xDS gRPC
This page explains how to enable xDS gRPC usage in your Quarkus application.
Validation with Hibernate Validator
This guide covers how to use Hibernate Validator/Bean Validation in your REST services.
Writing REST Services with RESTEasy Reactive
Discover how to develop highly scalable reactive REST services with JAX-RS and RESTEasy Reactive.
Writing Your Own Extension
Quarkus extensions optimize your applications by pushing as much work as possible to the build operation.
Writing simpler reactive REST services with Quarkus Virtual Thread support
This guide explains how to benefit from Java 19 virtual threads when writing REST services in Quarkus.