Micronaut Guides

Getting Started

1

Creating your first Micronaut application

Learn how to create a Hello World Micronaut application with a controller and a functional test.

Core Basics

3

Micronaut Scope Types

Learn about the available scopes: Singleton, Prototype, Request, Refreshable, Context...

Micronaut Dependency Injection Types

Constructor, field, and method parameter injection.

@Configuration and @ConfigurationBuilder

Learn how to use @Configuration and @ConfigurationBuilder annotations to configure declared properties.

HTTP Server

3

Content negotiation in a Micronaut application

Learn how to respond with HTML or JSON depending on the request Accept HTTP header.

Configure CORS in a Micronaut application

Learn how to configure Cross-Origin Resource Sharing (CORS) in a Micronaut application.

Exposing a Health endpoint for your Micronaut application

Learn how to expose a health endpoint for your Micronaut application.

HTTP Client

2

Download a big file with StreamingHttpClient

Learn how to stream responses with ReactorStreamingHttpClient

Read

Micronaut HTTP Client

Learn how to use Micronaut low-level HTTP Client. Simplify your code with the declarative HTTP client.

Development

2

Using IntelliJ IDEA to develop Micronaut applications

Delegate run and build actions to Gradle and Maven when working with IntelliJ IDEA

Adding Commit Info to your Micronaut Application

Expose the exact version of code that your application is running.

Testing

5

Replace H2 with a real database for testing

This guide shows how to replace H2 with a real database for testing in a Micronaut application.

Testing Kafka Listener using Testcontainers with the Micronaut Framework

This guide shows how to test a Kafka Listener using Testcontainers in a Micronaut Framework application.

Testing REST API integrations using Testcontainers with WireMock or MockServer

This guide shows how to test an external API integration using Testcontainers WireMock module.

Working with jOOQ and Flyway using Testcontainers

This guide shows how to create a Micronaut application with jOOQ support

Read

Using Micronaut Test REST-Assured in a Micronaut application

Learn how to use Micronaut Test REST-Assured to test the REST API of your Micronaut application.

Data Access

4

Using EclipseStore persistence with Micronaut

Learn how to use EclipseStore as a high-performance persistence layer.

Using DynamoDB in a Micronaut application

Learn how to use DynamoDB as your persistence solution in a Micronaut application.

Access an Oracle Autonomous Database

Learn how to access an Oracle Autonomous Database using the Micronaut framework.

Access a database with MyBatis

Learn how to access a database with MyBatis using Micronaut Framework.

Data JDBC

12

Find Nearby Delivery Drivers with Micronaut Data JDBC and H2GIS

Learn how to use Micronaut Data JDBC and H2 spatial queries to find the closest available delivery driver within 5 km of a food delivery order.

Find Nearby Delivery Drivers with Micronaut Data JDBC and MariaDB Geospatial

Learn how to use Micronaut Data JDBC and MariaDB spatial queries to find the closest available delivery driver within 5 km of a food delivery order.

Find Nearby Delivery Drivers with Micronaut Data JDBC and MySQL Geospatial

Learn how to use Micronaut Data JDBC and MySQL spatial queries to find the closest available delivery driver within 5 km of a food delivery order.

Find Nearby Delivery Drivers with Micronaut Data JDBC and PostGIS

Learn how to use Micronaut Data JDBC and PostgreSQL spatial queries to find the closest available delivery driver within 5 km of a food delivery order.

Find Nearby Delivery Drivers with Micronaut Data JDBC and SQL Server Geospatial

Learn how to use Micronaut Data JDBC and SQL Server spatial queries to find the closest available delivery driver within 5 km of a food delivery order.

Find Nearby Delivery Drivers with Micronaut Data JDBC and Oracle Geospatial

Learn how to use Micronaut Data JDBC and Oracle spatial queries to find the closest available delivery driver within 5 km of a food delivery order.

Connect a Micronaut Data JDBC Application to an AWS RDS MySQL Database

Learn how to connect to an AWS MySQL database.

Connect a Micronaut Data JDBC Application to Azure Database for MySQL

Learn how to connect a Micronaut Data JDBC application to Microsoft Azure Database for MySQL.

Connect a Micronaut Data JDBC Application to a Google MySQL Database

Learn how to connect to a Google MySQL database.

Deploy a Micronaut MySQL Database Application to Oracle Cloud

Learn how to deploy a Micronaut MySQL database application to Oracle Cloud.

Micronaut Data and Java Records

Learn how to leverage Java records for immutable configuration, Micronaut Data Mapped Entities and Projection DTOs

Access a database with Micronaut Data JDBC

Learn how to access a database with Micronaut JDBC repositories.

Data JPA

3

Access a database with JPA and Hibernate Reactive

Learn how to use Hibernate Reactive with the Micronaut Framework.

Access a database with Micronaut Data and Hibernate Reactive

Learn how to use Micronaut Data and Hibernate Reactive.

Access a database with JPA and Hibernate

Learn how to access a database with JPA and Hibernate using the Micronaut framework.

Data R2DBC

1

Access a database with Micronaut Data R2DBC

Learn how to access a database with Micronaut R2DBC repositories.

GraalVM

1

Generate reflection metadata for GraalVM Native Image

In this guide, you will see several methods to provide the metadata required for reflection to be used in a Micronaut application distributed as a GraalVM Native executable.

Serverless

4

Deploy an HTTP Function to Google Cloud Functions

Deploy a Micronaut application as an HTTP Function to Google Cloud Functions, a scalable pay-as-you-go functions-as-a-service (FaaS) to run your code with zero server management.

Deploy a Micronaut HTTP API Gateway Function (Serverless) application to Oracle Cloud

Learn how to deploy a Micronaut HTTP API Gateway Function (Serverless) application to Oracle Cloud.

Deploy a Micronaut Function (Serverless) application to Oracle Cloud

Learn how to deploy a Micronaut Function (Serverless) application to Oracle Cloud.

Micronaut Azure HTTP Functions

Learn how to create an Azure HTTP Function with the Micronaut framework

AWS Lambda

10

Micronaut RequestStreamHandler as a GraalVM Native Executable to AWS Lambda

Learn how to distribute a Micronaut function with an AWS Lambda RequestStreamHandler built as a GraalVM native executable to an AWS Lambda custom runtime.

Micronaut RequestStreamHandler to Lambda Java Runtime

Learn how to deploy a Micronaut function to AWS Lambda Java Runtime with an AWS Lambda RequestStreamHandler.

AWS Lambda Function URL and a Micronaut function

Deploy a Micronaut function to AWS Lambda Java 17 runtime and invoke it with a Lambda function URL.

Secret Rotation AWS Lambda and Secrets Manager

Learn how to create an AWS Lambda function with the Micronaut framework to rotate a secret stored in AWS Secrets Manager

Micronaut AWS Lambda and a Cron Job

Learn how to use a scheduled expression with an EventBridge trigger to execute a Micronaut AWS Lambda every 5 minutes

Micronaut AWS Lambda and S3 Event

Learn how to generate thumbnails for images uploaded to an S3 bucket with AWS Lambda and the Micronaut framework

Deploy a Micronaut application as a GraalVM Native Executable to AWS Lambda

Learn how to distribute a Micronaut application built as a GraalVM native executable to an AWS Lambda custom runtime

Deploy a Micronaut application to AWS Lambda Java Runtime

Learn how to distribute a Micronaut application to AWS Lambda Runtime

Deploy a Micronaut function as a GraalVM Native Executable to AWS Lambda

Learn how to distribute a Micronaut function built as a GraalVM native executable to an AWS Lambda custom runtime

Deploy a Serverless Micronaut function to AWS Lambda Java 17 Runtime

Learn how to distribute a serverless Micronaut function to AWS Lambda 17 Runtime

Kubernetes

4

Service discovery and distributed configuration with Google Kubernetes Engine (GKE)

Service discovery and distributed configuration in a Micronaut application with Google Kubernetes Engine (GKE)

Kubernetes service discovery and distributed configuration

How to use Kubernetes service discovery and distributed configuration in a Micronaut application

Service discovery and distributed configuration with Amazon Elastic Kubernetes Service (EKS)

Service discovery and distributed configuration in a Micronaut application with Amazon Elastic Kubernetes Service (EKS)

Service discovery and distributed configuration with Oracle Cloud Container Engine for Kubernetes (OKE)

Service discovery and distributed configuration in a Micronaut application with Oracle Cloud Container Engine for Kubernetes (OKE)

Authorization Code

10

Secure a Micronaut application with an OCI Identity Domain using cookie authentication

Learn how to create a Micronaut application and secure it with an OCI (Oracle Cloud Infrastructure) Identity Domain.

Secure a Micronaut application with an OCI Identity Domain using idtoken authentication

Learn how to create a Micronaut application and secure it with an OCI (Oracle Cloud Infrastructure) Identity Domain.

Secure a Micronaut application with Keycloak

Learn how to create a Micronaut application and secure it with an Authorization Server provided by Keycloak.

Authenticate Micronaut application users with OpenID Connect and Oracle IDCS

Learn how to create a secured Micronaut application and authenticate with OpenID Connect in Oracle Cloud.

Secure a Micronaut application with Auth0

Learn how to create a Micronaut application and secure it with an Authorization Server provided by Auth0.

Secure a Micronaut application with LinkedIn

Learn how to create a Micronaut application and authenticate with LinkedIn.

Secure a Micronaut application with GitHub

Learn how to create a Micronaut application and secure it with an Authorization Server provided by GitHub. Learn how to write your own Authentication Mapper.

Secure a Micronaut application with Cognito

Learn how to create a Micronaut application and secure it with an Authorization Server provided by Cognito.

Secure a Micronaut application with Google

Learn how to create a Micronaut application, secure it with Google, and provide authentication with OpenID Connect.

Secure a Micronaut application with Okta

Learn how to create a Micronaut application and secure it with an Authorization Server provided by Okta.

Beyond JSON

3

Render XML in a Micronaut Controller

Learn how to use Jackson to render XML in a Micronaut Controller

Download a PDF with OpenPDF

Learn how to generate a PDF in a Micronaut Controller with OpenPDF.

Download an Excel file in a Micronaut application

Learn how to download an Excel file with the Micronaut framework and Spreadsheet Builder library.

Boot to Micronaut Building a REST API

6

6. Security Basic Authentication - Spring Boot vs Micronaut Framework - Building a REST API

This guide compares how to secure a REST API with basic authentication in Micronaut and Spring Boot applications.

Micronaut Cache

Learn how to use Micronaut caching annotations

Client Credentials

3

Client Credentials Flow with Micronaut and Oracle Identity Domain

Learn how to use Client Credentials Flow between Micronaut microservices with an Authorization Server provided by Oracle Identity Domain.

Client Credentials Flow with Micronaut and Auth0

Learn how to use Client Credentials Flow between Micronaut microservices with an Authorization Server provided by Auth0.

Client Credentials Flow with Micronaut and Amazon Cognito

Learn how to use Client Credentials Flow between Micronaut microservices with an Authorization Server provided by Amazon Cognito.

Coordinated Restore at Checkpoint

2

Micronaut CRaC

Learn how to start using CRaC with a Micronaut application.

Deploy CRaC Docker Image to Google Cloud Run

Deploy a Docker image containing a CRaC-enabled JDK and a pre-warmed, checkpointed application to Google Cloud Run, a fully managed serverless platform for containerized applications.

Database Modeling

3

Many-to-Many with Micronaut Data JDBC and MySQL

Learn how to map a many-to-many association with Micronaut Data JDBC and MySQL.

Many-to-Many with Micronaut Data JDBC and Oracle

Learn how to map a many-to-many association with Micronaut Data JDBC and Oracle.

One-to-Many with Micronaut Data JDBC

Learn how to map a one-to-many association with Micronaut Data JDBC.

Distributed Configuration

1

Micronaut AWS Parameter Store

Learn how to use AWS Parameter for Configuration Discovery in a Micronaut application.

Distributed Tracing

7

Microservices Distributed Tracing with OpenTelemetry through X-Ray and the Micronaut Framework

Use AWS X-Ray distributed tracing to investigate the behavior of your Micronaut applications.

OpenTelemetry Tracing with Google Cloud Trace and the Micronaut Framework

Use Google Cloud Trace to investigate the behavior of your Micronaut applications.

OpenTelemetry Tracing with Oracle Cloud and the Micronaut Framework

Use Oracle Cloud to investigate the behavior of your Micronaut applications.

Use OpenTelemetry with Jaeger and the Micronaut Framework for Microservice Distributed Tracing

Use Jaeger distributed tracing to investigate the behavior of your Micronaut applications.

Use OpenTelemetry with Zipkin and the Micronaut Framework for Microservice Distributed Tracing

Use Zipkin distributed tracing to investigate the behavior of your Micronaut applications.

Use OpenTracing with Jaeger and the Micronaut Framework for Microservice Distributed Tracing

Use Jaeger distributed tracing to investigate the behaviour of your Micronaut applications.

Use OpenTracing with Zipkin and the Micronaut Framework for Microservice Distributed Tracing

Use Zipkin distributed tracing to investigate the behaviour of your Micronaut applications.

Distribution

9

Building a Docker image of your Micronaut application

Micronaut build plugins offer several ways to build Docker images: JAR, GraalVM native executable, and CRaC.

Create an Executable JAR of a Micronaut application

Learn how to generate an executable JAR of a Micronaut application with Maven or Gradle.

Deploy to Google Cloud Compute

Deploy a Micronaut application to a Google Cloud Compute instance.

Deploy to Google App Engine

Learn how to deploy a Micronaut application to the Google App Engine Java flexible environment.

Deploy GraalVM Native Executable to Google Cloud Run

Deploy a GraalVM Native Executable of a Micronaut application to Google Cloud Run - a fully managed serverless platform for containerized applications.

Deploy a Micronaut application to Oracle Cloud

Learn how to deploy a Micronaut application to Oracle Cloud.

Deploy a Micronaut application to Microsoft Azure

Learn how to deploy a Micronaut application to Microsoft Azure.

Read

Creating your first Micronaut Graal application

Learn how to create a Hello World Micronaut GraalVM application.

Deploy a Micronaut application to AWS Elastic Beanstalk

Learn how easy it is to deploy a Micronaut application to Elastic Beanstalk.

Email

3

Oracle Cloud Infrastructure (OCI) Email Delivery using the Micronaut framework

Learn how to send an email with Oracle Cloud Infrastructure (OCI) Email Delivery using the Micronaut framework.

Send Emails with Amazon SES from the Micronaut Framework

Learn how to send emails with Amazon SES from a Micronaut application.

Send Emails with SendGrid from the Micronaut Framework

Learn how to send emails with SendGrid from a Micronaut application.

GraalPy

2

Creating a Micronaut GraalPy application using a Python package

Learn how to create a simple Micronaut GraalPy application using a third-party Python package.

Read

Creating your first Micronaut GraalPy application

Read

Logging

2

Publish Micronaut application logs to Microsoft Azure Monitor Logs

Learn how to send your Micronaut application Logback logs to Microsoft Azure Monitor Logs.

Log incoming HTTP Request headers with a Server Filter

Learn to log every HTTP Request header with a @ServerFilter and a method annotated with @FilterRequest.

MCP

4

MCP Weather Server with HTTP transport

Build an MCP weather server with HTTP transport.

MCP Weather Server with STDIO transport

Build an MCP weather server with STDIO transport.

Disk Space MCP Server with STDIO transport

Build an MCP Server with STDIO transport to expose your machine disk space.

Disk Space MCP Server with Streamable HTTP transport

Build an MCP Server with Streamable HTTP transport to expose your machine disk space.

Messaging

6

Connect a Micronaut JMS Application to an AWS SQS Queue

Learn how to connect JMS Application to an AWS SQS Queue

Publishing and subscribing to MQTT Topics from a Micronaut Application

Learn how to use Mosquitto as an MQTT broker, create a Micronaut CLI application and publish an MQTT topic, and subscribe to the MQTT topic in a different Micronaut Messaging application.

Oracle Cloud Streaming and the Micronaut Framework - Event-Driven Applications at Scale

Use Oracle Cloud Streaming to communicate between your Micronaut applications.

Kafka and the Micronaut Framework - Event-Driven Applications

Use Kafka to communicate between your Micronaut applications.

RabbitMQ RPC and the Micronaut Framework

Use RabbitMQ RPC to use request-reply pattern in your Micronaut applications.

RabbitMQ and the Micronaut Framework - Event-Driven Applications

Use RabbitMQ to communicate between your Micronaut applications.

Metrics

3

Collect metrics with the Micronaut framework and monitor them on Amazon CloudWatch

Learn how to collect standard and custom metrics with the Micronaut framework and monitor them on Amazon CloudWatch.

Collect metrics with the Micronaut Framework and monitor them on Oracle Cloud

Learn how to collect standard and custom metrics with the Micronaut framework and monitor them on Oracle Cloud.

Collect Metrics with Micronaut

Learn how to collect standard and custom metrics with the Micronaut framework.

Micronaut Security

12

Testing Micronaut Security

Learn how to test your application's behavior when a user with specific roles is authenticated

Database authentication

Learn how to secure a Micronaut application using Database authentication.

Micronaut Security API Key

Learn how to secure a Micronaut application using an API Key.

X.509 Mutual Authentication

Learn how to implement mutual authentication using SSL and X.509 certificates.

JWK Generation with a Micronaut Command Line Application

Learn how to generate a JSON Web Key (JWK) with a Micronaut CLI (command-line interface) application

JWK Keys endpoint

Learn how to expose a keys endpoint with primary and secondary JSON Web Key (JWK)

Micronaut Token Propagation

Learn how to leverage token propagation in the Micronaut framework to simplify your code while keeping your microservices secure.

LDAP and database authentication providers

Learn how to create an LDAP and a database authentication provider in a Micronaut application.

Read

Micronaut Basic Auth

Learn how to secure a Micronaut application using 'Basic' HTTP Authentication Scheme.

Micronaut JWT Authentication

Learn how to secure a Micronaut application using JWT (JSON Web Token) Authentication.

Micronaut JWT authentication via Cookies

Learn how to secure a Micronaut application using JWT (JSON Web Token) based authentication where the JWT tokens are transported via Cookies.

Session-based authentication

Learn how to secure a Micronaut application using session-based authentication.

MongoDB

4

Access a MongoDB database asynchronously with Micronaut Data MongoDB and Reactive Streams

Learn how to access a MongoDB database asynchronously with Micronaut Data.

Access a MongoDB database with Micronaut Data MongoDB

Learn how to access a MongoDB database with Micronaut Data and the MongoDB Sync driver.

Micronaut MongoDB Asynchronous

Learn how to use a non-blocking reactive streams MongoDB client with a Micronaut application

Micronaut MongoDB Synchronous

Learn how to use a blocking MongoClient with a Micronaut application

Object Storage

3

Use the Micronaut Object Storage API to store files in Google Cloud Storage

Learn how to upload and retrieve files from Google Cloud Storage using the Micronaut Object Storage API

Use the Micronaut Object Storage API to store files in Oracle Cloud Infrastructure (OCI) Object Storage

Learn how to upload and retrieve files from Oracle Cloud Infrastructure (OCI) Object Storage using the Micronaut Object Storage API

Use the Micronaut Object Storage API to store files in Amazon S3

Learn how to upload and retrieve files from Amazon S3 using the Micronaut Object Storage API

OpenAPI

4

Generate API documentation in Asciidoc with the generated OpenAPI specification of your Micronaut application

Learn how to generate an OpenAPI specification of your Micronaut application at build time and generate it in Asciidoc format.

Read

Visualize an OpenAPI specification of your Micronaut application with Swagger UI

Learn how to generate an OpenAPI specification of your Micronaut application at build time and visualize it with Swagger UI.

Use OpenAPI Definition to Generate a Micronaut Client

Learn how to generate a Declarative Micronaut Client API from an OpenAPI definition and how to use it in your application

Micronaut Server generation with OpenAPI

Learn how to write an OpenAPI definition, use it to generate a server template for a Micronaut application, and get it all to work

Patterns

1

Micronaut Patterns - Composite

Learn how to use a Composite Pattern if you have multiple beans of particular type

Registry

3

Push a Docker image of a Micronaut application to Docker Hub

Learn how to push a Docker image of a Micronaut application to Docker Hub

Read

Push a Docker image of a Micronaut application to GitHub Packages Container registry

Learn how to push a Docker image of a Micronaut application to GitHub Packages Container registry

Read

Push a Docker image of a Micronaut application to Oracle Cloud Container Registry

Latest Guides

Search Results

Learning Path

All Topics

Getting Started

Core Basics

HTTP Server

HTTP Client

Development

Testing

Data Access

Data JDBC

Data JPA

Data R2DBC

GraalVM

Serverless

AWS Lambda

Kubernetes

Authorization Code

Beyond JSON

Boot to Micronaut Building a REST API

Cache

Client Credentials

Coordinated Restore at Checkpoint

Database Modeling

Distributed Configuration

Distributed Tracing

Distribution

Email

GraalPy

GraphQL

i18n

JAX-RS

JSON Schema

Kotlin

Logging