Spring Boot

https://github.com/spring-projects/spring-boot
Admin
Spring Boot helps you to create Spring-powered, production-grade applications and services with...
Tokens:1,302,116
Snippets:7,146
Trust Score:9.7
License:Apache-2.0
Update:2 hours ago
Show doc for...
Tokens:
Raw
### Get command help with spring help init

Source: https://github.com/spring-projects/spring-boot/blob/main/documentation/spring-boot-docs/src/docs/antora/modules/cli/pages/using-the-cli.adoc

Displays detailed usage, flag options, and examples for the spring init command.

```shell
$ spring help init
spring init - Initialize a new project using Spring Initializr (start.spring.io)

usage: spring init [options] [location]

Option                       Description
------                       -----------
-a, --artifact-id <String>   Project coordinates; infer archive name (for
                               example 'test')
-b, --boot-version <String>  Spring Boot version (for example '1.2.0.RELEASE')
--build <String>             Build system to use (for example 'maven' or
                               'gradle') (default: maven)
-d, --dependencies <String>  Comma-separated list of dependency identifiers to
                               include in the generated project
--description <String>       Project description
-f, --force                  Force overwrite of existing files
--format <String>            Format of the generated content (for example
                               'build' for a build file, 'project' for a
                               project archive) (default: project)
-g, --group-id <String>      Project coordinates (for example 'org.test')
-j, --java-version <String>  Language level (for example '1.8')
-l, --language <String>      Programming language  (for example 'java')
--list                       List the capabilities of the service. Use it to
                               discover the dependencies and the types that are
                               available
-n, --name <String>          Project name; infer application name
-p, --packaging <String>     Project packaging (for example 'jar')
--package-name <String>      Package name
-t, --type <String>          Project type. Not normally needed if you use --
                               build and/or --format. Check the capabilities of
                               the service (--list) for more details
--target <String>            URL of the service to use (default: https://start.
                               spring.io)
-v, --version <String>       Project version (for example '0.0.1-SNAPSHOT')
-x, --extract                Extract the project archive. Inferred if a
                               location is specified without an extension

examples:

    To list all the capabilities of the service:
        $ spring init --list

    To creates a default project:
        $ spring init

    To create a web my-app.zip:
        $ spring init -d=web my-app.zip

    To create a web/data-jpa gradle project unpacked:
        $ spring init -d=web,jpa --build=gradle my-dir
```

--------------------------------

### Install Spring Boot CLI with SDKMAN!

Source: https://github.com/spring-projects/spring-boot/blob/main/documentation/spring-boot-docs/src/docs/antora/modules/ROOT/pages/installing.adoc

Install the Spring Boot CLI using SDKMAN! and verify the installed version.

```shell
$ sdk install springboot
$ spring --version
Spring CLI v{version-spring-boot}
```

--------------------------------

### Install Spring Boot CLI using Scoop on Windows

Source: https://github.com/spring-projects/spring-boot/blob/main/documentation/spring-boot-docs/src/docs/antora/modules/ROOT/pages/installing.adoc

Install the Spring Boot CLI on Windows using the Scoop package manager. Installs to ~/scoop/apps/springboot/current/bin.

```shell
$ scoop bucket add extras
$ scoop install springboot
```

--------------------------------

### Install Spring Boot CLI using Homebrew

Source: https://github.com/spring-projects/spring-boot/blob/main/documentation/spring-boot-docs/src/docs/antora/modules/ROOT/pages/installing.adoc

Install the Spring Boot CLI on macOS using Homebrew. Installs the spring binary to /usr/local/bin.

```shell
$ brew tap spring-io/tap
$ brew install spring-boot
```

--------------------------------

### Verify Gradle installation

Source: https://github.com/spring-projects/spring-boot/blob/main/documentation/spring-boot-docs/src/docs/antora/modules/tutorial/pages/first-application/index.adoc

Run gradle --version to check the installed Gradle version and environment details if you choose Gradle as your build system.

```shell
$ gradle --version

------------------------------------------------------------
Gradle 8.14.4
------------------------------------------------------------

Build time:    2026-01-23 16:30:23 UTC
Revision:      ad5ff774b4b0e9a8a0cf1a14ca70d7230003c3ad

Kotlin:        2.0.21
Groovy:        3.0.25
Ant:           Apache Ant(TM) version 1.10.15 compiled on August 25 2024
Launcher JVM:  17.0.18 (BellSoft 17.0.18+10-LTS)
Daemon JVM:    /Users/developer/.sdkman/candidates/java/17.0.18-librca (no JDK specified, using current Java home)
OS:            Mac OS X 26.3 aarch64
```

--------------------------------

### YAML hierarchical configuration example

Source: https://github.com/spring-projects/spring-boot/blob/main/documentation/spring-boot-docs/src/docs/antora/modules/reference/pages/features/external-config.adoc

Example YAML document with nested environments. Used to illustrate how YAML is flattened into properties.

```yaml
environments:
  dev:
    url: "https://dev.example.com"
    name: "Developer Setup"
  prod:
    url: "https://another.example.com"
    name: "My Cool App"
```

--------------------------------

### GET /actuator/startup

Source: https://github.com/spring-projects/spring-boot/blob/main/documentation/spring-boot-actuator-docs/src/docs/antora/modules/api/pages/rest/actuator/startup.adoc

Retrieves a snapshot of the steps recorded so far during the application startup phase without clearing the buffer.

```APIDOC
## GET /actuator/startup

### Description
Retrieves a snapshot of the steps recorded so far during the application startup phase.

### Method
GET

### Endpoint
/actuator/startup

### Response
#### Success Response
Contains details of the application startup steps recorded so far.
```

--------------------------------

### List Installed Spring Boot Versions with SDKMAN!

Source: https://github.com/spring-projects/spring-boot/blob/main/documentation/spring-boot-docs/src/docs/antora/modules/ROOT/pages/installing.adoc

Check available, installed, and active local Spring Boot CLI versions in SDKMAN!.

```shell
$ sdk ls springboot

================================================================================
Available Springboot Versions
================================================================================
> + dev
* {version-spring-boot}

================================================================================
+ - local version
* - installed
> - currently in use
================================================================================
```

--------------------------------

### YAML list configuration example

Source: https://github.com/spring-projects/spring-boot/blob/main/documentation/spring-boot-docs/src/docs/antora/modules/reference/pages/features/external-config.adoc

Example YAML document containing a list. Used to illustrate how YAML lists are flattened into properties with index notation.

```yaml
 my:
  servers:
  - "dev.example.com"
  - "another.example.com"
```

--------------------------------

### Enable systemd service with systemctl enable

Source: https://github.com/spring-projects/spring-boot/blob/main/documentation/spring-boot-docs/src/docs/antora/modules/how-to/pages/deployment/installing.adoc

Flags the application service to start automatically on system boot.

```shell
$ systemctl enable myapp.service
```

--------------------------------

### Verify Java installation

Source: https://github.com/spring-projects/spring-boot/blob/main/documentation/spring-boot-docs/src/docs/antora/modules/tutorial/pages/first-application/index.adoc

Run java -version in a terminal to confirm that a valid Java runtime is installed before creating the application.

```shell
$ java -version
openjdk version "17.0.18" 2026-01-20 LTS
OpenJDK Runtime Environment (build 17.0.18+10-LTS)
OpenJDK 64-Bit Server VM (build 17.0.18+10-LTS, mixed mode, sharing)
```

--------------------------------

### Verify Spring Boot CLI installation

Source: https://github.com/spring-projects/spring-boot/blob/main/cli/spring-boot-cli/src/main/content/INSTALL.txt

Test that the CLI has been successfully installed and is available in your PATH.

```shell
	spring --version
```

--------------------------------

### Configure server properties in application.yaml

Source: https://github.com/spring-projects/spring-boot/blob/main/documentation/spring-boot-docs/src/docs/antora/modules/specification/pages/configuration-metadata/format.adoc

Example showing how properties defined in metadata (such as server.port and server.address) are assigned values in an application configuration file.

```yaml
server:
  port: 9090
  address: 127.0.0.1
```

--------------------------------

### View Sample Startup Failure Output

Source: https://github.com/spring-projects/spring-boot/blob/main/documentation/spring-boot-docs/src/docs/antora/modules/reference/pages/features/spring-application.adoc

Displays error details and suggested corrective actions provided by FailureAnalyzer when an application fails to start due to a port conflict.

```text
***************************
APPLICATION FAILED TO START
***************************

Description:

Embedded servlet container failed to start. Port 8080 was already in use.

Action:

Identify and stop the process that is listening on port 8080 or configure this application to listen on another port.
```

--------------------------------

### Install a Local Development Version with SDKMAN!

Source: https://github.com/spring-projects/spring-boot/blob/main/documentation/spring-boot-docs/src/docs/antora/modules/ROOT/pages/installing.adoc

Configure a custom-built local development instance of the Spring Boot CLI using SDKMAN! pointing to target build output.

```shell
$ sdk install springboot dev /path/to/spring-boot/spring-boot-cli/target/spring-boot-cli-{version-spring-boot}-bin/spring-{version-spring-boot}/
$ sdk default springboot dev
$ spring --version
Spring CLI v{version-spring-boot}
```

--------------------------------

### Verify Maven installation

Source: https://github.com/spring-projects/spring-boot/blob/main/documentation/spring-boot-docs/src/docs/antora/modules/tutorial/pages/first-application/index.adoc

Run mvn -v to verify that Apache Maven is properly installed and configured if you choose Maven as your build system.

```shell
$ mvn -v
Apache Maven 3.9.12 (848fbb4bf2d427b72bdb2471c22fced7ebd9a7a1)
Maven home: /Users/developer/.sdkman/candidates/maven/current
Java version: 17.0.18, vendor: BellSoft, runtime: /Users/developer/.sdkman/candidates/java/17.0.18-librca
```

--------------------------------

### Install Spring Boot CLI using MacPorts

Source: https://github.com/spring-projects/spring-boot/blob/main/documentation/spring-boot-docs/src/docs/antora/modules/ROOT/pages/installing.adoc

Install the Spring Boot CLI on macOS using MacPorts.

```shell
$ sudo port install spring-boot-cli
```

--------------------------------

### Check installed version with spring version

Source: https://github.com/spring-projects/spring-boot/blob/main/documentation/spring-boot-docs/src/docs/antora/modules/cli/pages/using-the-cli.adoc

Displays the installed version of the Spring Boot CLI.

```shell
$ spring version
Spring CLI v{version-spring-boot}
```

--------------------------------

### Random value property configuration example

Source: https://github.com/spring-projects/spring-boot/blob/main/documentation/spring-boot-docs/src/docs/antora/modules/reference/pages/features/external-config.adoc

Example YAML configuration using RandomValuePropertySource to inject random values. Shows syntax for random.value, random.int, random.long, random.uuid, and random.int with bounds.

```yaml
my:
  secret: "${random.value}"
  number: "${random.int}"
  bignumber: "${random.long}"
  uuid: "${random.uuid}"
  number-less-than-ten: "${random.int(10)}"
  number-in-range: "${random.int[1024,65536]}"
```

--------------------------------

### Example layers.idx file structure

Source: https://github.com/spring-projects/spring-boot/blob/main/documentation/spring-boot-docs/src/docs/antora/modules/reference/pages/packaging/container-images/efficient-images.adoc

Defines the order and contents of image layers to separate frequently changing application code from stable dependencies.

```yaml
- "dependencies":
  - BOOT-INF/lib/library1.jar
  - BOOT-INF/lib/library2.jar
- "spring-boot-loader":
  - org/springframework/boot/loader/launch/JarLauncher.class
  - ... <other classes>
- "snapshot-dependencies":
  - BOOT-INF/lib/library3-SNAPSHOT.jar
- "application":
  - META-INF/MANIFEST.MF
  - BOOT-INF/classes/a/b/C.class
```

--------------------------------

### Enable Command-line Completion for Bash

Source: https://github.com/spring-projects/spring-boot/blob/main/documentation/spring-boot-docs/src/docs/antora/modules/ROOT/pages/installing.adoc

Manually source the bash completion script when installed via SDKMAN! to enable tab completion.

```shell
$ . ~/.sdkman/candidates/springboot/current/shell-completion/bash/spring
$ spring <HIT TAB HERE>
  encodepassword  help  init  shell  version
```

--------------------------------

### Start Ant with the Spring Boot AntLib jar

Source: https://github.com/spring-projects/spring-boot/blob/main/documentation/spring-boot-docs/src/docs/antora/modules/build-tool-plugin/pages/antlib.adoc

Use the -lib option when invoking Ant to point to the directory containing the spring-boot-antlib jar file.

```shell
$ ant -lib <directory containing spring-boot-antlib-{version-spring-boot}.jar>
```

--------------------------------

### Run application with Gradle bootRun

Source: https://github.com/spring-projects/spring-boot/blob/main/documentation/spring-boot-docs/src/docs/antora/modules/tutorial/pages/first-application/index.adoc

Starts the application using the org.springframework.boot Gradle plugin's bootRun task from the project root directory.

```shell
$ gradle bootRun

  .   ____          _            __ _ _
 /\\ / ___'_ __ _ _(_)_ __  __ _ \ \ \ \
( ( )\___ | '_ | '_| | '_ \/ _` | \ \ \ \
 \\/  ___)| |_)| | | | | || (_| |  ) ) ) )
  '  |____| .__|_| |_|_| |_\__, | / / / /
 =========|_|==============|___/=/_/_/_/
 :: Spring Boot ::  (v{version-spring-boot})
....... . . .
....... . . . (log output here)
....... . . .
........ Started MyApplication in 0.906 seconds (process running for 6.514)
```

--------------------------------

### Building images using pack CLI with Gradle jar path

Source: https://github.com/spring-projects/spring-boot/wiki/Building-OCI-Images-with-Spring-Boot

Test and diagnose local buildpack setup issues by passing the Gradle-built JAR file to the pack build command.

```bash
pack build --builder paketobuildpacks/builder-jammy-base:latest --path build/libs/myproject-0.0.1-SNAPSHOT.jar myproject
```

--------------------------------

### Configure and Execute Unix Start Script for Spring Boot

Source: https://github.com/spring-projects/spring-boot/blob/main/build-plugin/spring-boot-gradle-plugin/src/main/resources/unixStartScript.txt

Escapes application arguments, builds Java execution arguments with system properties and JAR path, fixes current directory when launched from macOS Finder, and executes the Java command.

```shell
# Escape application args
save ( ) {
    for i do printf %s\\n "\$i" | sed "s/'/'\\\\''/g;1s/^/'/;\\\$s/\\\$/' \\\\/" ; done
    echo " "
}
APP_ARGS=\$(save "\$@")

# Collect all arguments for the java command, following the shell quoting and substitution rules
eval set -- \$DEFAULT_JVM_OPTS \$JAVA_OPTS \$${optsEnvironmentVar} <% if ( appNameSystemProperty ) { %>"\"-D${appNameSystemProperty}=\$APP_BASE_NAME\"" <% } %>-jar "\"\$JARPATH\"" "\$APP_ARGS"

# by default we should be in the correct project dir, but when run from Finder on Mac, the cwd is wrong
if [ "\$(uname)" = "Darwin" ] && [ "\$HOME" = "\$PWD" ]; then
  cd "\$(dirname "\$0")"
fi

exec "\$JAVACMD" "\$@"
```

--------------------------------

### Building images using pack CLI with Maven jar path

Source: https://github.com/spring-projects/spring-boot/wiki/Building-OCI-Images-with-Spring-Boot

Test and diagnose local buildpack setup issues by passing the Maven-built JAR file to the pack build command.

```bash
pack build --builder paketobuildpacks/builder-jammy-base:latest --path target/myproject-0.0.1-SNAPSHOT.jar myproject
```

--------------------------------

### Start application with -XX:SharedArchiveFile

Source: https://github.com/spring-projects/spring-boot/blob/main/documentation/spring-boot-docs/src/docs/antora/modules/reference/pages/packaging/aot-cache.adoc

Runs the extracted application using the generated CDS application.jsa archive file. Must be run against the extracted application form.

```shell
$ java -XX:SharedArchiveFile=application.jsa -jar my-app.jar
```

--------------------------------

### Run native image container with docker run

Source: https://github.com/spring-projects/spring-boot/blob/main/documentation/spring-boot-docs/src/docs/antora/modules/reference/pages/packaging/native-image/advanced-topics.adoc

Starts the container created by pack, publishing container port 8080 to host port 8080 and automatically removing the container upon exit.

```shell
$ docker run --rm -p 8080:8080 docker.io/library/myproject:0.0.1-SNAPSHOT
```

--------------------------------

### List service capabilities with spring init --list

Source: https://github.com/spring-projects/spring-boot/blob/main/documentation/spring-boot-docs/src/docs/antora/modules/cli/pages/using-the-cli.adoc

Queries start.spring.io to output available dependency identifiers and capabilities.

```shell
$ spring init --list
=======================================
Capabilities of https://start.spring.io
=======================================

Available dependencies:
-----------------------
actuator - Actuator: Production ready features to help you monitor and manage your application
...
web - Web: Support for full-stack web development, including Tomcat and spring-webmvc
websocket - Websocket: Support for WebSocket development
ws - WS: Support for Spring Web Services
```

--------------------------------

### Create a project with spring init --dependencies

Source: https://github.com/spring-projects/spring-boot/blob/main/documentation/spring-boot-docs/src/docs/antora/modules/cli/pages/using-the-cli.adoc

Creates and extracts a new Spring Boot project configured with specified dependencies using start.spring.io.

```shell
$ spring init --dependencies=web,data-jpa my-project
Using service at https://start.spring.io
Project extracted to '/Users/developer/example/my-project'
```

--------------------------------

### Start application with -XX:AOTCache

Source: https://github.com/spring-projects/spring-boot/blob/main/documentation/spring-boot-docs/src/docs/antora/modules/reference/pages/packaging/aot-cache.adoc

Launches the extracted application using the generated app.aot cache file. The cache file must be used with the extracted form of the application to take effect.

```shell
$ java -XX:AOTCache=app.aot -jar my-app.jar
```

--------------------------------

### Define multi-stage Dockerfile using jarmode

Source: https://github.com/spring-projects/spring-boot/blob/main/documentation/spring-boot-docs/src/docs/antora/modules/reference/pages/packaging/container-images/dockerfiles.adoc

Configure a multi-stage Dockerfile that uses extracted jar layers and starts the application jar. The resulting layout improves startup efficiency and is compatible with AOT cache and CDS.

```dockerfile
include::reference:partial$dockerfile[]
# Start the application jar - this is not the uber jar used by the builder
# This jar only contains application code and references to the extracted jar files
# This layout is efficient to start up and AOT cache (and CDS) friendly
ENTRYPOINT ["java", "-jar", "application.jar"]
```

--------------------------------

### Externalize SpringApplication settings using spring.main

Source: https://github.com/spring-projects/spring-boot/blob/main/documentation/spring-boot-docs/src/docs/antora/modules/how-to/pages/properties-and-configuration.adoc

Sets `spring.main` properties in configuration to disable the startup banner and prevent starting an embedded web server.

```yaml
spring:
  main:
    web-application-type: "none"
    banner-mode: "off"
```

--------------------------------

### POST /actuator/startup

Source: https://github.com/spring-projects/spring-boot/blob/main/documentation/spring-boot-actuator-docs/src/docs/antora/modules/api/pages/rest/actuator/startup.adoc

Drains and returns the steps recorded so far during the application startup phase from the buffer.

```APIDOC
## POST /actuator/startup

### Description
Drains and returns the steps recorded so far during the application startup phase.

### Method
POST

### Endpoint
/actuator/startup

### Response
#### Success Response
Contains details of the drained application startup steps.
```

--------------------------------

### Configure Heroku Procfile for Spring Boot Application

Source: https://github.com/spring-projects/spring-boot/blob/main/documentation/spring-boot-docs/src/docs/antora/modules/how-to/pages/deployment/cloud.adoc

Defines the launch command in a Procfile to start a Spring Boot application on Heroku. Uses the -Dserver.port=$PORT argument to bind embedded web servers to the dynamic port assigned by Heroku.

```procfile
web: java -Dserver.port=$PORT -jar target/demo-0.0.1-SNAPSHOT.jar
```

--------------------------------

### Set up Maven pom.xml configuration

Source: https://github.com/spring-projects/spring-boot/blob/main/documentation/spring-boot-docs/src/docs/antora/modules/tutorial/pages/first-application/index.adoc

Define the base pom.xml file referencing spring-boot-starter-parent to provide dependency management and build defaults.

```xml
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
	<modelVersion>4.0.0</modelVersion>
    <parent>
		<groupId>org.springframework.boot</groupId>
		<artifactId>spring-boot-starter-parent</artifactId>
		<version>{version-spring-boot}</version>
	</parent>
	<groupId>com.example</groupId>
	<artifactId>myproject</artifactId>
	<version>0.0.1-SNAPSHOT</version>

	<!-- Additional lines to be added here... -->

ifeval::["{build-and-artifact-release-type}" == "opensource-snapshot"]
    <!-- you don't need this if you are using a release version -->
    <repositories>
        <repository>
            <id>spring-snapshots</id>
            <url>https://repo.spring.io/snapshot</url>
            <snapshots>
                <enabled>true</enabled>
            </snapshots>
        </repository>
    </repositories>
    <pluginRepositories>
        <pluginRepository>
            <id>spring-snapshots</id>
            <url>https://repo.spring.io/snapshot</url>
            <snapshots>
                <enabled>true</enabled>
            </snapshots>
        </pluginRepository>
    </pluginRepositories>
endif::[]
</project>
```

--------------------------------

### Define HelloWorld service in proto3

Source: https://github.com/spring-projects/spring-boot/blob/main/documentation/spring-boot-docs/src/docs/antora/modules/reference/pages/io/grpc.adoc

Defines a sample gRPC service with SayHello RPC and request/reply message structures. Use proto files placed in src/main/proto for Java code generation.

```protobuf
syntax = "proto3";

option java_package = "com.example.grpc.proto";
option java_multiple_files = true;

service HelloWorld {
    rpc SayHello (HelloRequest) returns (HelloReply) {}
}

message HelloRequest {
    string name = 1;
}

message HelloReply {
    string message = 1;
}
```

--------------------------------

### Configure Additional SBOMs with management.endpoint.sbom.additional

Source: https://github.com/spring-projects/spring-boot/blob/main/documentation/spring-boot-docs/src/docs/antora/modules/reference/pages/actuator/endpoints.adoc

Adds an SBOM called "system" located at `/system.spdx.json`. Use the `optional:` prefix to prevent application startup failure if the file does not exist.

```yaml
management:
  endpoint:
    sbom:
      additional:
        system:
          location: "optional:file:/system.spdx.json"
          media-type: "application/spdx+json"
```

--------------------------------

### Configure initial Gradle build script in build.gradle

Source: https://github.com/spring-projects/spring-boot/blob/main/documentation/spring-boot-docs/src/docs/antora/modules/tutorial/pages/first-application/index.adoc

Sets up a basic Gradle build script configured with Java 17, Spring Boot plugin, dependency management plugin, and Maven Central repository. Verify the build by executing gradle classes.

```gradle
plugins {
	id 'java'
	id 'org.springframework.boot' version '{version-spring-boot}'
	id 'io.spring.dependency-management' version '{version-dependency-management-plugin}'
}

group = 'com.example'
version = '0.0.1-SNAPSHOT'

java {
	toolchain {
		languageVersion = JavaLanguageVersion.of(17)
	}
}

repositories {
	mavenCentral()
ifeval::["{build-and-artifact-release-type}" == "opensource-snapshot"]
	// you don't need this if you are using a release version
	maven { url 'https://repo.spring.io/snapshot' }
endif::[]
}

dependencies {
}
```

--------------------------------

### Create a minimal Spring Boot application

Source: https://github.com/spring-projects/spring-boot/blob/main/README.adoc

Defines a complete standalone Spring Boot application with a REST controller handling requests at the root path. Run the main method to start the embedded server.

```java
import org.springframework.boot.*;
import org.springframework.boot.autoconfigure.*;
import org.springframework.web.bind.annotation.*;

@RestController
@SpringBootApplication
public class Example {

	@RequestMapping("/")
	String home() {
		return "Hello World!";
	}

	public static void main(String[] args) {
		SpringApplication.run(Example.class, args);
	}

}
```

--------------------------------

### GET /actuator/caches

Source: https://github.com/spring-projects/spring-boot/blob/main/documentation/spring-boot-actuator-docs/src/docs/antora/modules/api/pages/rest/actuator/caches.adoc

Retrieves details of all caches available in the application.

```APIDOC
## GET /actuator/caches

### Description
Retrieves the application's caches.

### Method
GET

### Endpoint
/actuator/caches

### Response
#### Success Response (200)
Contains details of the application's caches.
```

--------------------------------

### GET /actuator/loggers/{logger.name}

Source: https://github.com/spring-projects/spring-boot/blob/main/documentation/spring-boot-actuator-docs/src/docs/antora/modules/api/pages/rest/actuator/loggers.adoc

Retrieves details of a single logger by name.

```APIDOC
## GET /actuator/loggers/{logger.name}

### Description
Retrieves details of a single logger by name.

### Method
GET

### Endpoint
/actuator/loggers/{logger.name}

### Parameters
#### Path Parameters
- **logger.name** (string) - Required - The name of the logger to retrieve (e.g., `com.example`).
```

--------------------------------

### Create an executable jar with explicit start-class using exejar

Source: https://github.com/spring-projects/spring-boot/blob/main/documentation/spring-boot-docs/src/docs/antora/modules/build-tool-plugin/pages/antlib.adoc

Use the exejar task with a specified start-class attribute, resources collection, and library classpath dependencies.

```xml
<spring-boot:exejar destfile="target/my-application.jar"
		classes="target/classes" start-class="com.example.MyApplication">
	<resources>
		<fileset dir="src/main/resources" />
	</resources>
	<lib>
		<fileset dir="lib" />
	</lib>
</spring-boot:exejar>
```

--------------------------------

### Deploy application with Cloud Foundry CLI

Source: https://github.com/spring-projects/spring-boot/blob/main/documentation/spring-boot-docs/src/docs/antora/modules/how-to/pages/deployment/cloud.adoc

Deploy an executable JAR to Cloud Foundry using the `cf push` command after building the application and logging in to the CLI. The command uploads the package, resolves the Java buildpack, configures runtime memory settings, and starts the instance.

```shell
$ cf push acloudyspringtime -p target/demo-0.0.1-SNAPSHOT.jar
```

```text
Uploading acloudyspringtime... *OK*
Preparing to start acloudyspringtime... *OK*
-----> Downloaded app package (*8.9M*)
-----> Java Buildpack Version: v3.12 (offline) | https://github.com/cloudfoundry/java-buildpack.git#6f25b7e
-----> Downloading Open Jdk JRE
       Expanding Open Jdk JRE to .java-buildpack/open_jdk_jre (1.6s)
-----> Downloading Open JDK Like Memory Calculator 2.0.2_RELEASE from https://java-buildpack.cloudfoundry.org/memory-calculator/trusty/x86_64/memory-calculator-2.0.2_RELEASE.tar.gz (found in cache)
       Memory Settings: -Xss349K -Xmx681574K -XX:MaxMetaspaceSize=104857K -Xms681574K -XX:MetaspaceSize=104857K
-----> Downloading Container Certificate Trust Store 1.0.0_RELEASE from https://java-buildpack.cloudfoundry.org/container-certificate-trust-store/container-certificate-trust-store-1.0.0_RELEASE.jar (found in cache)
       Adding certificates to .java-buildpack/container_certificate_trust_store/truststore.jks (0.6s)
-----> Downloading Spring Auto Reconfiguration 1.10.0_RELEASE from https://java-buildpack.cloudfoundry.org/auto-reconfiguration/auto-reconfiguration-1.10.0_RELEASE.jar (found in cache)
Checking status of app 'acloudyspringtime'...
  0 of 1 instances running (1 starting)
  ...
  0 of 1 instances running (1 starting)
  ...
  0 of 1 instances running (1 starting)
  ...
  1 of 1 instances running (1 running)

App started
```

--------------------------------

### GET /actuator/loggers

Source: https://github.com/spring-projects/spring-boot/blob/main/documentation/spring-boot-actuator-docs/src/docs/antora/modules/api/pages/rest/actuator/loggers.adoc

Retrieves the application's loggers and their configured levels.

```APIDOC
## GET /actuator/loggers

### Description
Retrieves the application's loggers and their configured levels.

### Method
GET

### Endpoint
/actuator/loggers
```

--------------------------------

### Create a Gradle war project using spring init

Source: https://github.com/spring-projects/spring-boot/blob/main/documentation/spring-boot-docs/src/docs/antora/modules/cli/pages/using-the-cli.adoc

Initializes a new Gradle project configured for Java 17, WebSocket dependencies, and war packaging, saving the archive to sample-app.zip.

```shell
$ spring init --build=gradle --java-version=17 --dependencies=websocket --packaging=war sample-app.zip
Using service at https://start.spring.io
Content saved to 'sample-app.zip'
```

--------------------------------

### GET /actuator/flyway

Source: https://github.com/spring-projects/spring-boot/blob/main/documentation/spring-boot-actuator-docs/src/docs/antora/modules/api/pages/rest/actuator/flyway.adoc

Retrieves information about database migrations performed by Flyway.

```APIDOC
## GET /actuator/flyway

### Description
Provides information about database migrations performed by Flyway.

### Method
GET

### Endpoint
/actuator/flyway

### Response
#### Success Response
Contains details of the application's Flyway migrations.
```

--------------------------------

### GET /actuator/loggers/{group.name}

Source: https://github.com/spring-projects/spring-boot/blob/main/documentation/spring-boot-actuator-docs/src/docs/antora/modules/api/pages/rest/actuator/loggers.adoc

Retrieves details of a single logger group by name.

```APIDOC
## GET /actuator/loggers/{group.name}

### Description
Retrieves details of a single logger group by name.

### Method
GET

### Endpoint
/actuator/loggers/{group.name}

### Parameters
#### Path Parameters
- **group.name** (string) - Required - The name of the logger group to retrieve (e.g., `test`).
```

--------------------------------

### GET /actuator/quartz/triggers/{groupName}

Source: https://github.com/spring-projects/spring-boot/blob/main/documentation/spring-boot-actuator-docs/src/docs/antora/modules/api/pages/rest/actuator/quartz.adoc

Retrieves an overview summary of triggers in a particular trigger group.

```APIDOC
## GET /actuator/quartz/triggers/{groupName}

### Description
Retrieves an overview of the triggers in a particular group.

### Method
GET

### Endpoint
/actuator/quartz/triggers/{groupName}

### Parameters
#### Path Parameters
- **groupName** (String) - Required - The name of the trigger group

### Response
#### Success Response (200)
Contains an overview of triggers in the specified group.
```

--------------------------------

### Configure value hints with any provider for system.state

Source: https://github.com/spring-projects/spring-boot/blob/main/documentation/spring-boot-docs/src/docs/antora/modules/specification/pages/configuration-metadata/manual-hints.adoc

Offers auto-completion values such as `on` and `off` while permitting any additional value to be specified via the `any` provider. Regular value validation based on the property type still applies if supported.

```json
{"hints": [
	{
		"name": "system.state",
		"values": [
			{
				"value": "on"
			},
			{
				"value": "off"
			}
		],
		"providers": [
			{
				"name": "any"
			}
		]
	}
]}
```

--------------------------------

### GET /actuator/quartz/jobs/{groupName}

Source: https://github.com/spring-projects/spring-boot/blob/main/documentation/spring-boot-actuator-docs/src/docs/antora/modules/api/pages/rest/actuator/quartz.adoc

Retrieves an overview summary of jobs in a particular job group.

```APIDOC
## GET /actuator/quartz/jobs/{groupName}

### Description
Retrieves an overview of the jobs in a particular group.

### Method
GET

### Endpoint
/actuator/quartz/jobs/{groupName}

### Parameters
#### Path Parameters
- **groupName** (String) - Required - The name of the job group

### Response
#### Success Response (200)
Contains an overview of jobs in the specified group.
```

--------------------------------

### GET /actuator/quartz/triggers

Source: https://github.com/spring-projects/spring-boot/blob/main/documentation/spring-boot-actuator-docs/src/docs/antora/modules/api/pages/rest/actuator/quartz.adoc

Retrieves the list of registered trigger names grouped by their respective group names.

```APIDOC
## GET /actuator/quartz/triggers

### Description
Retrieves the list of registered trigger names.

### Method
GET

### Endpoint
/actuator/quartz/triggers

### Response
#### Success Response (200)
Contains the registered trigger names for each group.
```

--------------------------------

### GET /actuator/sbom

Source: https://github.com/spring-projects/spring-boot/blob/main/documentation/spring-boot-actuator-docs/src/docs/antora/modules/api/pages/rest/actuator/sbom.adoc

Retrieves a list of available Software Bill of Materials (SBOMs) provided by the application.

```APIDOC
## GET /actuator/sbom

### Description
Retrieves the available Software Bill of Materials (SBOMs).

### Method
GET

### Endpoint
/actuator/sbom
```

--------------------------------

### GET /actuator/sessions/{id}

Source: https://github.com/spring-projects/spring-boot/blob/main/documentation/spring-boot-actuator-docs/src/docs/antora/modules/api/pages/rest/actuator/sessions.adoc

Retrieves the details of a single session identified by its unique session ID.

```APIDOC
## GET /actuator/sessions/{id}

### Description
Retrieves the details of a single session with the specified ID.

### Method
GET

### Endpoint
/actuator/sessions/{id}

### Parameters
#### Path Parameters
- **id** (String) - Required - The ID of the session to retrieve.
```

--------------------------------

### GET /actuator/quartz/jobs

Source: https://github.com/spring-projects/spring-boot/blob/main/documentation/spring-boot-actuator-docs/src/docs/antora/modules/api/pages/rest/actuator/quartz.adoc

Retrieves the list of registered job names grouped by their respective group names.

```APIDOC
## GET /actuator/quartz/jobs

### Description
Retrieves the list of registered job names.

### Method
GET

### Endpoint
/actuator/quartz/jobs

### Response
#### Success Response (200)
Contains the registered job names for each group.
```

--------------------------------

### GET /actuator/metrics

Source: https://github.com/spring-projects/spring-boot/blob/main/documentation/spring-boot-actuator-docs/src/docs/antora/modules/api/pages/rest/actuator/metrics.adoc

Retrieves the names of the available application metrics. Useful for discovering what metrics are registered.

```APIDOC
## GET /actuator/metrics

### Description
Retrieves the names of all available metrics registered in the application.

### Method
GET

### Endpoint
/actuator/metrics

### Response
#### Success Response (200)
- **names** (array) - List of available metric names.
```

--------------------------------

### Display Spring CLI help and available commands

Source: https://github.com/spring-projects/spring-boot/blob/main/documentation/spring-boot-docs/src/docs/antora/modules/cli/pages/using-the-cli.adoc

Run the spring command without arguments to view usage syntax, common options, and a list of available subcommands.

```shell
$ spring
usage: spring [--help] [--version]
       <command> [<args>]

Available commands are:

  init [options] [location]
    Initialize a new project using Spring Initializr (start.spring.io)

  encodepassword [options] <password to encode>
    Encode a password for use with Spring Security

  shell
    Start a nested shell

Common options:

  --debug Verbose mode
    Print additional status information for the command you are running


See 'spring help <command>' for more information on a specific command.
```

--------------------------------

### GET /actuator/quartz

Source: https://github.com/spring-projects/spring-boot/blob/main/documentation/spring-boot-actuator-docs/src/docs/antora/modules/api/pages/rest/actuator/quartz.adoc

Retrieves the list of registered job and trigger groups managed by the Quartz Scheduler.

```APIDOC
## GET /actuator/quartz

### Description
Retrieves the list of registered job and trigger groups managed by the Quartz Scheduler.

### Method
GET

### Endpoint
/actuator/quartz

### Response
#### Success Response (200)
Contains the group names for registered jobs and triggers.
```

--------------------------------

### Build a multi-module project with the native profile

Source: https://github.com/spring-projects/spring-boot/blob/main/build-plugin/spring-boot-maven-plugin/src/docs/antora/modules/maven-plugin/pages/aot.adoc

Executes the package phase with the native profile enabled across sub-modules configured for native image generation.

```shell
$ mvn package -Pnative
```

--------------------------------

### Launch JAR with tools jar mode

Source: https://github.com/spring-projects/spring-boot/blob/main/documentation/spring-boot-docs/src/docs/antora/modules/reference/pages/packaging/container-images/dockerfiles.adoc

Launch the application JAR with `-Djarmode=tools` to view and run available utility commands. It displays available options including `extract`, `list-layers`, and `sbom`.

```shell
$ java -Djarmode=tools -jar my-app.jar
```

```text
Usage:
  java -Djarmode=tools -jar my-app.jar

Available commands:
  extract      Extract the contents from the jar
  list-layers  List layers from the jar that can be extracted
  sbom         Print the SBOM from the jar
  help         Help about any command
```

--------------------------------

### YAML properties with only enabled flag

Source: https://github.com/spring-projects/spring-boot/blob/main/documentation/spring-boot-docs/src/docs/antora/modules/reference/pages/features/external-config.adoc

Example properties where the `security` property is not present at all. The `Security` instance will be `null`.

```yaml
my:
  service:
    enabled: true
```

--------------------------------

### GET /actuator/httpexchanges

Source: https://github.com/spring-projects/spring-boot/blob/main/documentation/spring-boot-actuator-docs/src/docs/antora/modules/api/pages/rest/actuator/httpexchanges.adoc

Retrieves information about HTTP request-response exchanges. Returns the details of traced HTTP exchanges.

```APIDOC
## GET /actuator/httpexchanges

### Description
Provides information about HTTP request-response exchanges.

### Method
GET

### Endpoint
/actuator/httpexchanges

### Response
#### Success Response
Contains details of the traced HTTP request-response exchanges.
```

--------------------------------

### Import a configuration tree from a mounted volume using configtree:

Source: https://github.com/spring-projects/spring-boot/blob/main/documentation/spring-boot-docs/src/docs/antora/modules/reference/pages/features/external-config.adoc

Use the configtree: prefix to expose files in a directory as properties. The folder and file names form the property names.

```yaml
spring:
  config:
    import: "optional:configtree:/etc/config/"
```

--------------------------------

### GET /actuator/quartz/jobs/{groupName}/{jobName}

Source: https://github.com/spring-projects/spring-boot/blob/main/documentation/spring-boot-actuator-docs/src/docs/antora/modules/api/pages/rest/actuator/quartz.adoc

Retrieves full details about a specific job, including a summary of associated triggers.

```APIDOC
## GET /actuator/quartz/jobs/{groupName}/{jobName}

### Description
Retrieves the details about a particular job, including associated triggers sorted by next fire time and priority.

### Method
GET

### Endpoint
/actuator/quartz/jobs/{groupName}/{jobName}

### Parameters
#### Path Parameters
- **groupName** (String) - Required - The name of the job group
- **jobName** (String) - Required - The name of the job

### Response
#### Success Response (200)
Contains full details of the job, including associated trigger summaries.
```

--------------------------------

### Configure WarLauncher in META-INF/MANIFEST.MF

Source: https://github.com/spring-projects/spring-boot/blob/main/documentation/spring-boot-docs/src/docs/antora/modules/specification/pages/executable-jar/launching.adoc

Defines the manifest configuration for an executable war file, specifying WarLauncher as the bootstrap Main-Class and the application entry point as Start-Class. The classpath is deduced automatically from nested jars in WEB-INF/lib/ and WEB-INF/lib-provided/.

```manifest
Main-Class: org.springframework.boot.loader.launch.WarLauncher
Start-Class: com.mycompany.project.MyApplication
```

--------------------------------

### Configure Quartz JDBC Schema Initialization

Source: https://github.com/spring-projects/spring-boot/blob/main/documentation/spring-boot-docs/src/docs/antora/modules/reference/pages/io/quartz.adoc

Configures Quartz database schema initialization to run on application startup. Standard Quartz scripts drop existing tables on every restart by default.

```yaml
spring:
  quartz:
    jdbc:
      initialize-schema: "always"
```

--------------------------------

### GET /actuator/metrics/{metric.name}

Source: https://github.com/spring-projects/spring-boot/blob/main/documentation/spring-boot-actuator-docs/src/docs/antora/modules/api/pages/rest/actuator/metrics.adoc

Retrieves detailed information and measurements for a specific metric, with optional tag filtering for drilling down.

```APIDOC
## GET /actuator/metrics/{metric.name}

### Description
Retrieves information about a specific metric by name, with support for filtering or drilling down by tags.

### Method
GET

### Endpoint
/actuator/metrics/{metric.name}

### Parameters
#### Path Parameters
- **metric.name** (string) - Required - The name of the metric to retrieve (e.g., `jvm.memory.max`).

#### Query Parameters
- **tag** (string) - Optional - Tag key-value pairs used to drill down into the metric (e.g., `tag=key:value`).
```

--------------------------------

### GET /actuator/health

Source: https://github.com/spring-projects/spring-boot/blob/main/documentation/spring-boot-actuator-docs/src/docs/antora/modules/api/pages/rest/actuator/health.adoc

Retrieves the overall health of the application. The response contains details of the application's health status and indicators.

```APIDOC
## GET /actuator/health

### Description
Provides detailed information about the health of the application.

### Method
GET

### Endpoint
/actuator/health

### Response
#### Success Response
Returns the overall health status and details for the application.
```

--------------------------------

### Disable Meters with management.metrics.enable Property

Source: https://github.com/spring-projects/spring-boot/blob/main/documentation/spring-boot-docs/src/docs/antora/modules/reference/pages/actuator/metrics.adoc

Filters out and rejects meters starting with a specific name prefix (such as example.remote) from being registered in the MeterRegistry.

```yaml
management:
  metrics:
    enable:
      example:
        remote: false
```

--------------------------------

### Pulling builder and run images with Podman CLI

Source: https://github.com/spring-projects/spring-boot/wiki/Building-OCI-Images-with-Spring-Boot

Pull Paketo builder and run images manually using Podman CLI to troubleshoot image download errors.

```bash
podman pull docker.io/paketobuildpacks/builder-jammy-base:latest
podman pull docker.io/paketobuildpacks/run-jammy-base:latest
```

--------------------------------

### Configure protobuf-maven-plugin in pom.xml

Source: https://github.com/spring-projects/spring-boot/blob/main/documentation/spring-boot-docs/src/docs/antora/modules/reference/pages/io/grpc.adoc

Configures Maven build with spring-boot-starter-parent and io.github.ascopes:protobuf-maven-plugin to generate Java code from proto files.

```xml
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
	<modelVersion>4.0.0</modelVersion>
    <parent>
		<groupId>org.springframework.boot</groupId>
		<artifactId>spring-boot-starter-parent</artifactId>
		<version>{version-spring-boot}</version>
	</parent>
	<groupId>com.example</groupId>
	<artifactId>myproject</artifactId>
	<version>0.0.1-SNAPSHOT</version>

	<build>
		<plugins>
			<plugin>
				<groupId>io.github.ascopes</groupId>
				<artifactId>protobuf-maven-plugin</artifactId>
			</plugin>
			<plugin>
				<groupId>org.springframework.boot</groupId>
				<artifactId>spring-boot-maven-plugin</artifactId>
			</plugin>
		</plugins>
	</build>

ifeval::["{build-and-artifact-release-type}" == "opensource-snapshot"]
    <!-- you don't need this if you are using a release version -->
    <repositories>
        <repository>
            <id>spring-snapshots</id>
            <url>https://repo.spring.io/snapshot</url>
            <snapshots>
                <enabled>true</enabled>
            </snapshots>
        </repository>
    </repositories>
    <pluginRepositories>
        <pluginRepository>
            <id>spring-snapshots</id>
            <url>https://repo.spring.io/snapshot</url>
            <snapshots>
                <enabled>true</enabled>
            </snapshots>
        </pluginRepository>
    </pluginRepositories>
endif::[]
</project>
```

--------------------------------

### GET /actuator/scheduledtasks

Source: https://github.com/spring-projects/spring-boot/blob/main/documentation/spring-boot-actuator-docs/src/docs/antora/modules/api/pages/rest/actuator/scheduledtasks.adoc

Retrieves information about the application's scheduled tasks. Provides details regarding scheduled tasks configured in the application.

```APIDOC
## GET /actuator/scheduledtasks

### Description
Provides information about the application's scheduled tasks.

### Method
GET

### Endpoint
/actuator/scheduledtasks

### Response
#### Success Response
Contains details of the application's scheduled tasks.
```

--------------------------------

### Create an executable jar with auto-detected start-class using exejar

Source: https://github.com/spring-projects/spring-boot/blob/main/documentation/spring-boot-docs/src/docs/antora/modules/build-tool-plugin/pages/antlib.adoc

Omit start-class in the exejar task to let Spring Boot default to the first class found that declares a main method.

```xml
<exejar destfile="target/my-application.jar" classes="target/classes">
	<lib>
		<fileset dir="lib" />
	</lib>
</exejar>
```

--------------------------------

### GET /actuator/integrationgraph

Source: https://github.com/spring-projects/spring-boot/blob/main/documentation/spring-boot-actuator-docs/src/docs/antora/modules/api/pages/rest/actuator/integrationgraph.adoc

Retrieves the Spring Integration graph containing all Spring Integration components used within the application, as well as the links between them.

```APIDOC
## GET /actuator/integrationgraph

### Description
Retrieves information about the application's Spring Integration components and the links between them.

### Method
GET

### Endpoint
/actuator/integrationgraph

### Response
#### Success Response (200)
The response contains all Spring Integration components used within the application, as well as the links between them.
```

--------------------------------

### GET /actuator/health/{component}

Source: https://github.com/spring-projects/spring-boot/blob/main/documentation/spring-boot-actuator-docs/src/docs/antora/modules/api/pages/rest/actuator/health.adoc

Retrieves the health of a specific component within the application. Allows querying individual health indicators separately.

```APIDOC
## GET /actuator/health/{component}

### Description
Retrieves the health status and details of a particular component of the application.

### Method
GET

### Endpoint
/actuator/health/{component}

### Parameters
#### Path Parameters
- **component** (string) - Required - The name of the health component indicator to inspect.

### Response
#### Success Response
Returns health details for the specified component.
```

--------------------------------

### Build Executable Jar with Gradle bootJar

Source: https://github.com/spring-projects/spring-boot/blob/main/documentation/spring-boot-docs/src/docs/antora/modules/tutorial/pages/first-application/index.adoc

Run `gradle bootJar` from the command line to create an executable jar archive in the `build/libs` directory.

```shell
$ gradle bootJar

BUILD SUCCESSFUL in 639ms
3 actionable tasks: 3 executed
```

--------------------------------

### GET /actuator/env

Source: https://github.com/spring-projects/spring-boot/blob/main/documentation/spring-boot-actuator-docs/src/docs/antora/modules/api/pages/rest/actuator/env.adoc

Retrieves information about the entire application environment. The response contains details of all available environment property sources and configurations.

```APIDOC
## GET /actuator/env

### Description
To retrieve the entire environment, make a `GET` request to `/actuator/env`.

### Method
GET

### Endpoint
`/actuator/env`

### Response
#### Success Response (200)
Details of the application's `Environment`.
```

--------------------------------

### Publish image with authentication credentials via command line

Source: https://github.com/spring-projects/spring-boot/blob/main/build-plugin/spring-boot-maven-plugin/src/docs/antora/modules/maven-plugin/pages/build-image.adoc

Supply registry credentials, registry URL, and publish flags as command-line properties when publishing to an authenticated Docker registry.

```shell
$ mvn spring-boot:build-image \
      -Ddocker.publishRegistry.username=user \
      -Ddocker.publishRegistry.password=secret \
      -Ddocker.publishRegistry.url=docker.example.com \
      -Dspring-boot.build-image.publish=true \
      -Dspring-boot.build-image.imageName=docker.example.com/library/my-app:v1
```

--------------------------------

### GET /actuator/configprops

Source: https://github.com/spring-projects/spring-boot/blob/main/documentation/spring-boot-actuator-docs/src/docs/antora/modules/api/pages/rest/actuator/configprops.adoc

Retrieves all of the application's @ConfigurationProperties beans. Returns configuration property details across the entire application context.

```APIDOC
## GET /actuator/configprops

### Description
Retrieves all of the application's `@ConfigurationProperties` beans.

### Method
GET

### Endpoint
/actuator/configprops

### Response
#### Success Response (200)
Details of the application's `@ConfigurationProperties` beans.
```

--------------------------------

### Import extensionless file with shorthand extension hint

Source: https://github.com/spring-projects/spring-boot/blob/main/documentation/spring-boot-docs/src/docs/antora/modules/reference/pages/features/external-config.adoc

Imports an extensionless file as YAML by specifying the extension in square brackets. This is the shorthand syntax.

```yaml
spring:
  config:
    import: "file:/etc/config/myconfig[.yaml]"
```

--------------------------------

### Configure JarLauncher in META-INF/MANIFEST.MF

Source: https://github.com/spring-projects/spring-boot/blob/main/documentation/spring-boot-docs/src/docs/antora/modules/specification/pages/executable-jar/launching.adoc

Defines the manifest configuration for an executable jar file, specifying JarLauncher as the bootstrap Main-Class and the application entry point as Start-Class. Classpath entries do not need to be specified because the classpath is deduced from nested jars.

```manifest
Main-Class: org.springframework.boot.loader.launch.JarLauncher
Start-Class: com.mycompany.project.MyApplication
```

--------------------------------

### Configure External Application Properties Using Properties Format

Source: https://github.com/spring-projects/spring-boot/blob/main/documentation/spring-boot-docs/src/docs/antora/modules/how-to/pages/properties-and-configuration.adoc

Define application settings using standard period-separated key-value pairs in application.properties as an alternative to YAML.

```properties
spring.application.name=cruncher
spring.datasource.driver-class-name=com.mysql.jdbc.Driver
spring.datasource.url=jdbc:mysql://localhost/test
server.port=9000
```

--------------------------------

### GET /actuator/health/{component}/{subcomponent}

Source: https://github.com/spring-projects/spring-boot/blob/main/documentation/spring-boot-actuator-docs/src/docs/antora/modules/api/pages/rest/actuator/health.adoc

Retrieves the health of a nested component or subcomponent within the application. The endpoint supports arbitrary nesting depth.

```APIDOC
## GET /actuator/health/{component}/{subcomponent}

### Description
Retrieves the health of a nested component when a component contains other subcomponents. Supports any number of component identifiers in the path to inspect components at arbitrary depth.

### Method
GET

### Endpoint
/actuator/health/{component}/{subcomponent}

### Parameters
#### Path Parameters
- **component** (string) - Required - The name of the parent health component.
- **subcomponent** (string) - Required - The name of the nested subcomponent.

### Response
#### Success Response
Returns health details for the specified nested component instance.
```

--------------------------------

### GET /actuator/configprops/{prefix}

Source: https://github.com/spring-projects/spring-boot/blob/main/documentation/spring-boot-actuator-docs/src/docs/antora/modules/api/pages/rest/actuator/configprops.adoc

Retrieves @ConfigurationProperties beans mapped under a specified prefix. A general prefix matches all beans mapped under that prefix stem.

```APIDOC
## GET /actuator/configprops/{prefix}

### Description
Retrieves the `@ConfigurationProperties` beans mapped under a certain prefix. The prefix does not need to be exact; a more general prefix will return all beans mapped under that prefix stem.

### Method
GET

### Endpoint
/actuator/configprops/{prefix}

### Parameters
#### Path Parameters
- **prefix** (string) - Required - The prefix to filter configuration property beans by stem.

### Response
#### Success Response (200)
Details of the application's matching `@ConfigurationProperties` beans.
```

--------------------------------

### GET /actuator/caches/{name}

Source: https://github.com/spring-projects/spring-boot/blob/main/documentation/spring-boot-actuator-docs/src/docs/antora/modules/api/pages/rest/actuator/caches.adoc

Retrieves information about a specific cache by its name. If multiple caches share the same name, a cacheManager query parameter can be provided.

```APIDOC
## GET /actuator/caches/{name}

### Description
Retrieves a cache by name.

### Method
GET

### Endpoint
/actuator/caches/{name}

### Parameters
#### Path Parameters
- **name** (String) - Required - The name of the cache to retrieve.

#### Query Parameters
- **cacheManager** (String) - Optional - The name of the cache manager. Required if the cache name is not unique.

### Response
#### Success Response (200)
Contains details of the requested cache.
```

--------------------------------

### Configure Short Command Line Arguments with Placeholders

Source: https://github.com/spring-projects/spring-boot/blob/main/documentation/spring-boot-docs/src/docs/antora/modules/how-to/pages/properties-and-configuration.adoc

Use placeholders in configuration files to bind short command-line flags such as --port to nested configuration properties. This binding also supports platform environment variables like PORT in PaaS environments.

```yaml
server:
  port: "${port:8080}"
```

--------------------------------

### Pulling builder and run images with Docker CLI

Source: https://github.com/spring-projects/spring-boot/wiki/Building-OCI-Images-with-Spring-Boot

Pull Paketo builder and run images manually using Docker CLI to verify that the Docker daemon is functioning properly.

```bash
docker pull docker.io/paketobuildpacks/builder-jammy-base:latest
docker pull docker.io/paketobuildpacks/run-jammy-base:latest
```

--------------------------------

### External YAML Configuration for @ConfigurationProperties

Source: https://github.com/spring-projects/spring-boot/blob/main/documentation/spring-boot-docs/src/docs/antora/modules/reference/pages/features/external-config.adoc

Example YAML configuration that binds to a @ConfigurationProperties bean. The properties are nested under 'my.service' and include remote-address, security.username, and security.roles.

```yaml
my:
  service:
    remote-address: 192.168.1.1
    security:
      username: "admin"
      roles:
      - "USER"
      - "ADMIN"
```

--------------------------------

### GET /actuator/threaddump

Source: https://github.com/spring-projects/spring-boot/blob/main/documentation/spring-boot-actuator-docs/src/docs/antora/modules/api/pages/rest/actuator/threaddump.adoc

Retrieves a thread dump from the application's JVM. The response format can be requested as JSON or plain text depending on the Accept header.

```APIDOC
## GET /actuator/threaddump

### Description
Provides a thread dump from the application's JVM. Can be retrieved formatted as JSON or as plain text depending on the Accept header.

### Method
GET

### Endpoint
/actuator/threaddump

### Response
#### Success Response (200)
- Contains details of the JVM's threads (as JSON or `text/plain`).
```
Tokens:
Raw