Spring Boot

https://docs.spring.io/spring-boot/4.0-SNAPSHOT/
Admin
Spring Boot simplifies the development of production-ready, stand-alone Spring applications,...
Tokens:2,379,321
Snippets:36,779
Trust Score:10
Update:17 hours ago
Show doc for...
Tokens:
Raw
### GET /actuator/startup - Example response

Source: https://docs.spring.io/spring-boot/4.0-SNAPSHOT/api/rest/actuator/startup.html

Example HTTP response for a GET request to /actuator/startup. Shows the JSON structure with springBootVersion, timeline, and events containing startup step details.

```http
HTTP/1.1 200 OK
Content-Type: application/vnd.spring-boot.actuator.v3+json
Content-Length: 899

{
  "springBootVersion" : "4.0.10-SNAPSHOT",
  "timeline" : {
    "events" : [ {
      "duration" : "PT0.000005079S",
      "endTime" : "2026-10-21T07:25:31.243803450Z",
      "startTime" : "2026-10-21T07:25:31.243798371Z",
      "startupStep" : {
        "id" : 3,
        "name" : "spring.beans.instantiate",
        "parentId" : 2,
        "tags" : [ {
          "key" : "beanName",
          "value" : "homeController"
        } ]
      }
    }, {
      "duration" : "PT0.000017633S",
      "endTime" : "2026-10-21T07:25:31.243808309Z",
      "startTime" : "2026-10-21T07:25:31.243790676Z",
      "startupStep" : {
        "id" : 2,
        "name" : "spring.boot.application.starting",
        "tags" : [ {
          "key" : "mainApplicationClass",
          "value" : "com.example.startup.StartupApplication"
        } ]
      }
    } ],
    "startTime" : "2026-10-21T07:25:30.767276605Z"
  }
}
```

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

### Classpath Index File Example

Source: https://docs.spring.io/spring-boot/4.0-SNAPSHOT/specification/executable-jar/nested-jars.html

Shows the format of BOOT-INF/classpath.idx, listing jar names in classpath order, each line starting with dash space and names in double quotes.

```none
- "BOOT-INF/lib/dependency2.jar"
- "BOOT-INF/lib/dependency1.jar"
```

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

### Get detailed help for the init command

Source: https://docs.spring.io/spring-boot/4.0-SNAPSHOT/cli/using-the-cli.html

Running 'spring help init' displays the full usage and options for the init command, including examples for listing capabilities, creating a default project, creating a zip, and creating a gradle project.

```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

```

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

### Expected startup output from native image

Source: https://docs.spring.io/spring-boot/4.0-SNAPSHOT/how-to/native-image/developing-your-first-application.html

Example output when starting the native image. Startup time is much faster than a JVM-based Spring Boot application.

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

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

### Remote client startup output for RemoteSpringApplication

Source: https://docs.spring.io/spring-boot/4.0-SNAPSHOT/reference/using/devtools.html

Example output shown when running the remote client application. It displays the Spring Boot Remote banner and log lines indicating startup, the LiveReload server running on port 35729, and the application started successfully. The output includes the version 4.0.10-SNAPSHOT and Java 25.0.4.

```none
  .   ____          _                                              __ _ _
 /\\ / ___'_ __ _ _(_)_ __  __ _          ___               _      \ \ \ \
( ( )\___ | '_ | '_| | '_ \/ _` |        | _ \___ _ __  ___| |_ ___ \ \ \ \
 \\/  ___)| |_)| | | | | || (_| []::::::[]   / -_) '  \/ _ \  _/ -_) ) ) ) )
  '  |____| .__|_| |_|_| |_\__, |        |_|_\___|_|_|_\___/\__\___|/ / / /
 =========|_|==============|___/===================================/_/_/_/
 :: Spring Boot Remote ::  (v4.0.10-SNAPSHOT)

2026-10-21T07:29:28.196Z  INFO 62680 --- [           main] o.s.b.devtools.RemoteSpringApplication   : Starting RemoteSpringApplication v4.0.10-SNAPSHOT using Java 25.0.4 with PID 62680 (/Users/myuser/.m2/repository/org/springframework/boot/spring-boot-devtools/4.0.10-SNAPSHOT/spring-boot-devtools-4.0.10-SNAPSHOT.jar started by myuser in /opt/apps/)
2026-10-21T07:29:28.210Z  INFO 62680 --- [           main] o.s.b.devtools.RemoteSpringApplication   : No active profile set, falling back to 1 default profile: "default"
2026-10-21T07:29:30.264Z  INFO 62680 --- [           main] o.s.b.d.a.OptionalLiveReloadServer       : LiveReload server is running on port 35729
2026-10-21T07:29:30.374Z  INFO 62680 --- [           main] o.s.b.devtools.RemoteSpringApplication   : Started RemoteSpringApplication in 3.683 seconds (process running for 5.201)
```

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

### starting(ConfigurableBootstrapContext)

Source: https://docs.spring.io/spring-boot/4.0-SNAPSHOT/api/java/org/springframework/boot/SpringApplicationRunListener.html

Called immediately when the run method has first started. Can be used for very early initialization.

```APIDOC
## starting(ConfigurableBootstrapContext)

### Description
Called immediately when the run method has first started. Can be used for very early initialization.

### Method
starting

### Parameters
- `bootstrapContext` (ConfigurableBootstrapContext) - Required - the bootstrap context

### Response
void
```

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

### hasNotFailed() example

Source: https://docs.spring.io/spring-boot/4.0-SNAPSHOT/api/java/org/springframework/boot/test/context/assertj/ApplicationContextAssert.html

Verifies that the application has not failed to start. Throws AssertionError if the context failed to start.

```java
assertThat(context).hasNotFailed();
```

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

### hasFailed() example

Source: https://docs.spring.io/spring-boot/4.0-SNAPSHOT/api/java/org/springframework/boot/test/context/assertj/ApplicationContextAssert.html

Verifies that the application has failed to start. Throws AssertionError if the context started without a failure.

```java
assertThat(context).hasFailed();
```

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

### startRecording() - BufferingApplicationStartup

Source: https://docs.spring.io/spring-boot/4.0-SNAPSHOT/api/java/index-files/index-19.html

Starts the recording of steps and marks the beginning of the StartupTimeline.

```APIDOC
## startRecording()

### Description
Starts the recording of steps and marks the beginning of the `StartupTimeline`.

### Method
Method in class `org.springframework.boot.context.metrics.buffering.BufferingApplicationStartup`
```

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

### start(String name)

Source: https://docs.spring.io/spring-boot/4.0-SNAPSHOT/api/java/org/springframework/boot/context/metrics/buffering/BufferingApplicationStartup.html

Starts a new StartupStep with the given name. This method is specified by the ApplicationStartup interface.

```APIDOC
## Method: start(String name)

### Description
Starts a new StartupStep with the given name. This method is specified by the ApplicationStartup interface.

### Parameters
- **name** (String) - Required - The name of the step.

### Returns
- **StartupStep** - The started step.

```

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

### Configure podman local connection

Source: https://docs.spring.io/spring-boot/4.0-SNAPSHOT/maven-plugin/build-image.html

Use this XML configuration to make the plugin communicate with a podman container engine. The example sets the host to the podman socket path unix:///run/user/1000/podman/podman.sock and enables bindHostToBuilder. With the colima CLI installed, you can get the socket path using `podman info --format='{{.Host.RemoteSocket.Path}}'`.

```XML
<project>
	<build>
		<plugins>
			<plugin>
				<groupId>org.springframework.boot</groupId>
				<artifactId>spring-boot-maven-plugin</artifactId>
				<configuration>
					<docker>
						<host>unix:///run/user/1000/podman/podman.sock</host>
						<bindHostToBuilder>true</bindHostToBuilder>
					</docker>
				</configuration>
			</plugin>
		</plugins>
	</build>
</project>
```

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

### getFailure() example

Source: https://docs.spring.io/spring-boot/4.0-SNAPSHOT/api/java/org/springframework/boot/test/context/assertj/ApplicationContextAssert.html

Asserts that the application context failed to start and checks the failure message. Throws AssertionError if the context started without a failure.

```java
assertThat(context).getFailure().hasMessageContaining("missing bean");
```

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

### PropertiesLauncher.main(String[] args)

Source: https://docs.spring.io/spring-boot/4.0-SNAPSHOT/api/java/org/springframework/boot/loader/launch/PropertiesLauncher.html

Static entry point for launching an application using PropertiesLauncher. This method is called directly by users to start the application.

```APIDOC
## main(String[] args)

### Description
Static method that serves as the entry point for launching an application using PropertiesLauncher. It delegates to the Launcher's launch mechanism.

### Method
main

### Parameters
- **args** (String[]) - Required - Command line arguments passed to the application.

### Usage
Call this method directly to start the application with PropertiesLauncher.

### Example
```java
PropertiesLauncher.main(new String[] {"--server.port=8080"});
```
```

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

### HTTP Response for GET integrationgraph

Source: https://docs.spring.io/spring-boot/4.0-SNAPSHOT/api/rest/actuator/integrationgraph.html

Example response from the GET request, showing a 200 OK status with content type application/vnd.spring-boot.actuator.v3+json and a JSON body describing the integration graph.

```http
HTTP/1.1 200 OK
Content-Type: application/vnd.spring-boot.actuator.v3+json
Content-Length: 1042

{
  "contentDescriptor" : {
    "providerVersion" : "7.0.7-SNAPSHOT",
    "providerFormatVersion" : 1.2,
    "provider" : "spring-integration"
  },
  "links" : [ {
    "from" : 2,
    "to" : 3,
    "type" : "input"
  } ],
  "nodes" : [ {
    "nodeId" : 1,
    "name" : "nullChannel",
    "componentType" : "null-channel",
    "integrationPatternCategory" : "messaging_channel",
    "integrationPatternType" : "null_channel",
    "observed" : false,
    "properties" : { }
  }, {
    "nodeId" : 2,
    "name" : "errorChannel",
    "componentType" : "publish-subscribe-channel",
    "integrationPatternCategory" : "messaging_channel",
    "integrationPatternType" : "publish_subscribe_channel",
    "observed" : false,
    "properties" : { }
  }, {
    "nodeId" : 3,
    "name" : "errorLogger",
    "input" : "errorChannel",
    "componentType" : "logging-channel-adapter",
    "integrationPatternCategory" : "messaging_endpoint",
    "integrationPatternType" : "outbound_channel_adapter",
    "observed" : false,
    "properties" : { }
  } ]
}
```

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

### start()

Source: https://docs.spring.io/spring-boot/4.0-SNAPSHOT/api/java/org/springframework/boot/devtools/filewatch/FileSystemWatcher.html

Starts monitoring the source directory for changes.

```APIDOC
## start()

### Description
Starts monitoring the source directory for changes.

### Method
`public void start()`

### Parameters
None.

### Example
```java
watcher.start();
```
```

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

### Kotlin example of @DataCouchbaseTest

Source: https://docs.spring.io/spring-boot/4.0-SNAPSHOT/reference/testing/spring-boot-applications.html

Kotlin equivalent of the typical @DataCouchbaseTest setup. Uses constructor injection for the repository.

```kotlin
import org.springframework.beans.factory.annotation.Autowired
import org.springframework.boot.data.couchbase.test.autoconfigure.DataCouchbaseTest

@DataCouchbaseTest
class MyDataCouchbaseTests(@Autowired val repository: SomeRepository) {

	// ...

}
```

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

### BufferingApplicationStartup(int)

Source: https://docs.spring.io/spring-boot/4.0-SNAPSHOT/api/java/index-files/index-2.html

Constructor that creates a new buffered ApplicationStartup with a limited capacity and starts the recording of steps.

```APIDOC
## BufferingApplicationStartup(int)

### Description
Create a new buffered ApplicationStartup with a limited capacity and starts the recording of steps.

### Class
org.springframework.boot.context.metrics.buffering.BufferingApplicationStartup

### Constructor
BufferingApplicationStartup(int capacity)
```

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

### Kotlin example of @DataCassandraTest

Source: https://docs.spring.io/spring-boot/4.0-SNAPSHOT/reference/testing/spring-boot-applications.html

Kotlin equivalent of the typical @DataCassandraTest setup. Uses constructor injection for the repository.

```kotlin
import org.springframework.beans.factory.annotation.Autowired
import org.springframework.boot.data.cassandra.test.autoconfigure.DataCassandraTest

@DataCassandraTest
class MyDataCassandraTests(@Autowired val repository: SomeRepository)
```

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

### get(ApplicationContext)

Source: https://docs.spring.io/spring-boot/4.0-SNAPSHOT/api/java/org/springframework/boot/test/http/server/LocalTestWebServer.html

Returns the LocalTestWebServer instance provided from the ApplicationContext, or null if no local server is started or could be provided.

```APIDOC
## get(ApplicationContext)

### Description
Returns the LocalTestWebServer instance provided from the ApplicationContext, or null if no local server is started or could be provided.

### Method
static method

### Signature
`static @Nullable LocalTestWebServer get(ApplicationContext applicationContext)`

### Parameters
- **applicationContext** (ApplicationContext) - Required - The application context to obtain the server from.

### Returns
- **LocalTestWebServer** - The LocalTestWebServer instance, or null if not available.
```

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

### logStartupInfo(ConfigurableApplicationContext)

Source: https://docs.spring.io/spring-boot/4.0-SNAPSHOT/api/java/org/springframework/boot/SpringApplication.html

Called to log startup information, subclasses may override to add additional logging.

```APIDOC
## logStartupInfo(ConfigurableApplicationContext)

### Description
Called to log startup information, subclasses may override to add additional logging.

### Method
logStartupInfo

### Signature
protected void logStartupInfo(ConfigurableApplicationContext context)

### Parameters
- **context** (ConfigurableApplicationContext) - Required - The application context.

### Since
3.4.0
```

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

### spring-devtools.properties example for restart classloader customization

Source: https://docs.spring.io/spring-boot/4.0-SNAPSHOT/reference/using/devtools.html

Example properties file to exclude and include classpath entries for the restart classloader. The value is a regex pattern applied to the classpath. All property keys must be unique and start with restart.include. or restart.exclude.

```properties
restart.exclude.companycommonlibs="/mycorp-common-[\w\d-\.]/(build|bin|out|target)/"
restart.include.projectcommon="/mycorp-myproj-[\w\d-\.]+\.jar"
```

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

### Layer Index File Example

Source: https://docs.spring.io/spring-boot/4.0-SNAPSHOT/specification/executable-jar/nested-jars.html

Shows the format of BOOT-INF/layers.idx, defining layers and their contents for Docker/OCI image creation.

```none
- "dependencies":
  - "BOOT-INF/lib/dependency1.jar"
  - "BOOT-INF/lib/dependency2.jar"
- "application":
  - "BOOT-INF/classes/"
  - "META-INF/"
```

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

### curl GET request to retrieve trigger details

Source: https://docs.spring.io/spring-boot/4.0-SNAPSHOT/api/rest/actuator/quartz.html

Use this curl command to retrieve details of a Quartz trigger by specifying the group name and trigger name in the URL. The example retrieves the trigger with group 'samples' and name 'example'.

```bash
$ curl 'http://localhost:8080/actuator/quartz/triggers/samples/example' -i -X GET
```

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

### get(ApplicationContext applicationContext)

Source: https://docs.spring.io/spring-boot/4.0-SNAPSHOT/api/java/org/springframework/boot/test/http/server/LocalTestWebServer.html

Returns the LocalTestWebServer instance provided from the ApplicationContext or null if no local server is started or could be provided.

```APIDOC
## get(ApplicationContext applicationContext)

### Description
Returns the `LocalTestWebServer` instance provided from the `ApplicationContext` or `null` if no local server is started or could be provided.

### Method
get(ApplicationContext applicationContext)

### Parameters
- **applicationContext** (ApplicationContext) - Required - The application context.

### Returns
- **LocalTestWebServer** - The local test web server or `null`.
```

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

### POST /actuator/startup - Example response

Source: https://docs.spring.io/spring-boot/4.0-SNAPSHOT/api/rest/actuator/startup.html

Example HTTP response for a POST request to /actuator/startup. Shows the JSON structure with springBootVersion, timeline, and events containing startup step details.

```http
HTTP/1.1 200 OK
Content-Type: application/vnd.spring-boot.actuator.v3+json
Content-Length: 899

{
  "springBootVersion" : "4.0.10-SNAPSHOT",
  "timeline" : {
    "events" : [ {
      "duration" : "PT0.004329315S",
      "endTime" : "2026-10-21T07:25:31.161175984Z",
      "startTime" : "2026-10-21T07:25:31.156846669Z",
      "startupStep" : {
        "id" : 1,
        "name" : "spring.beans.instantiate",
        "parentId" : 0,
        "tags" : [ {
          "key" : "beanName",
          "value" : "homeController"
        } ]
      }
    }, {
      "duration" : "PT0.011888138S",
      "endTime" : "2026-10-21T07:25:31.161377333Z",
      "startTime" : "2026-10-21T07:25:31.149489195Z",
      "startupStep" : {
        "id" : 0,
        "name" : "spring.boot.application.starting",
        "tags" : [ {
          "key" : "mainApplicationClass",
          "value" : "com.example.startup.StartupApplication"
        } ]
      }
    } ],
    "startTime" : "2026-10-21T07:25:30.767276605Z"
  }
}
```

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

### Response for GET /actuator/sbom/{id} (CycloneDX)

Source: https://docs.spring.io/spring-boot/4.0-SNAPSHOT/api/rest/actuator/sbom.html

Example HTTP response for a single SBOM request. The response depends on the SBOM format; this example uses CycloneDX and includes a JSON body with bomFormat, specVersion, serialNumber, version, and additional fields.

```http
HTTP/1.1 200 OK
Content-Type: application/vnd.cyclonedx+json
Accept-Ranges: bytes
Content-Length: 160316

{
  "bomFormat" : "CycloneDX",
  "specVersion" : "1.5",
  "serialNumber" : "urn:uuid:13862013-3360-43e5-8055-3645aa43c548",
  "version" : 1,
  // ...
}

```

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

### start()

Source: https://docs.spring.io/spring-boot/4.0-SNAPSHOT/api/java/org/springframework/boot/devtools/livereload/LiveReloadServer.html

Starts the livereload server and accepts incoming connections. Returns the port on which the server is listening.

```APIDOC
## start()

### Description
Starts the livereload server and accepts incoming connections.

### Method
`public int start() throws IOException`

### Returns
- **int** - The port on which the server is listening.

### Throws
- **IOException** - In case of I/O errors.

```

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

### runApplication<MyApplication>(*args) example

Source: https://docs.spring.io/spring-boot/4.0-SNAPSHOT/reference/features/kotlin.html

Shows the idiomatic way to run a Spring Boot application with Kotlin. It is a drop-in replacement for SpringApplication.run(MyApplication::class.java, *args).

```kotlin
import org.springframework.boot.autoconfigure.SpringBootApplication
import org.springframework.boot.runApplication

@SpringBootApplication
class MyApplication

fun main(args: Array<String>) {
	runApplication<MyApplication>(*args)
}
```

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

### Standard @SpringBootApplication usage in Kotlin

Source: https://docs.spring.io/spring-boot/4.0-SNAPSHOT/reference/using/using-the-springbootapplication-annotation.html

Kotlin equivalent of the standard @SpringBootApplication example. Uses the runApplication top-level function to start the application.

```kotlin
import org.springframework.boot.autoconfigure.SpringBootApplication
import org.springframework.boot.runApplication

// Same as @SpringBootConfiguration @EnableAutoConfiguration @ComponentScan
@SpringBootApplication
class MyApplication

fun main(args: Array<String>) {
	runApplication<MyApplication>(*args)
}
```

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

### Kotlin @DataElasticsearchTest setup

Source: https://docs.spring.io/spring-boot/4.0-SNAPSHOT/reference/testing/spring-boot-applications.html

Kotlin equivalent of the Java @DataElasticsearchTest example. Uses constructor injection for the repository. Same auto-configuration behavior applies.

```kotlin
import org.springframework.beans.factory.annotation.Autowired
import org.springframework.boot.data.elasticsearch.test.autoconfigure.DataElasticsearchTest

@DataElasticsearchTest
class MyDataElasticsearchTests(@Autowired val repository: SomeRepository) {

	// ...

}
```

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

### Example Jar for Classpath Index

Source: https://docs.spring.io/spring-boot/4.0-SNAPSHOT/specification/executable-jar/nested-jars.html

Shows a sample jar structure used to illustrate the classpath index file format.

```none
example.jar
 |
 +-META-INF
 |  +-...
 +-BOOT-INF
    +-classes
    |  +...
    +-lib
       +-dependency1.jar
       +-dependency2.jar
```

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

### Kotlin @PulsarReader example

Source: https://docs.spring.io/spring-boot/4.0-SNAPSHOT/reference/messaging/pulsar.html

Kotlin version of the reader endpoint that starts reading from the beginning of 'someTopic'. Uses the same @PulsarReader annotation with 'earliest' startMessageId.

```kotlin
import org.springframework.pulsar.annotation.PulsarReader
import org.springframework.stereotype.Component

@Component
class MyBean {

	@PulsarReader(topics = ["someTopic"], startMessageId = "earliest")
	fun processMessage(content: String?) {
		// ...
	}

}
```

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

### logStartupInfo(boolean logStartupInfo)

Source: https://docs.spring.io/spring-boot/4.0-SNAPSHOT/api/java/org/springframework/boot/builder/SpringApplicationBuilder.html

Flags to indicate the startup information should be logged.

```APIDOC
## logStartupInfo(boolean logStartupInfo)

### Description
Flags to indicate the startup information should be logged.

### Method
logStartupInfo

### Parameters
#### Method Parameters
- **logStartupInfo** (boolean) - Required - The flag to set. Default true.

### Returns
- **SpringApplicationBuilder** - The current builder
```

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

### Retrieve mappings with curl

Source: https://docs.spring.io/spring-boot/4.0-SNAPSHOT/api/rest/actuator/mappings.html

Use this curl command to GET /actuator/mappings. The example includes headers for gzip encoding and a ReactorNetty user agent.

```bash
$ curl 'http://localhost:43845/actuator/mappings' -i -X GET \
    -H 'accept-encoding: gzip' \
    -H 'user-agent: ReactorNetty/1.3.8-SNAPSHOT' \
    -H 'accept: */*'
```

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

### start()

Source: https://docs.spring.io/spring-boot/4.0-SNAPSHOT/api/java/org/springframework/boot/logging/logback/StructuredLogEncoder.html

Starts the encoder lifecycle, initializing any resources needed.

```APIDOC
## start()

### Description
Starts the encoder. This method is called to initialize the encoder before it is used. It overrides the start method from EncoderBase and implements the LifeCycle interface.

### Method
`public void start()`

### Parameters
None.

### Returns
void

```

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

### HTTP Response for Single Logger

Source: https://docs.spring.io/spring-boot/4.0-SNAPSHOT/api/rest/actuator/loggers.html

Example HTTP response for a GET request to /actuator/loggers/com.example. Shows the response structure with configuredLevel and effectiveLevel fields.

```http
HTTP/1.1 200 OK
Content-Disposition: inline;filename=f.txt
Content-Type: application/vnd.spring-boot.actuator.v3+json
Content-Length: 61

{
  "configuredLevel" : "INFO",
  "effectiveLevel" : "INFO"
}
```

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

### start()

Source: https://docs.spring.io/spring-boot/4.0-SNAPSHOT/api/java/org/springframework/boot/jetty/JettyWebServer.html

Starts the web server. Calling this method on an already started server has no effect.

```APIDOC
## Method: start()

### Description
Starts the web server. Calling this method on an already started server has no effect.

### Signature
`public void start() throws WebServerException`

### Throws
- `WebServerException` - if the server cannot be started.
```

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

### Kotlin example: @Testcontainers with @SpringBootTest and Neo4jContainer

Source: https://docs.spring.io/spring-boot/4.0-SNAPSHOT/reference/testing/testcontainers.html

Kotlin version of the Testcontainers JUnit extension example. The container is declared in a companion object with @JvmStatic and @Container. The container starts before tests and is stopped after the test class, which can cause issues with cached Spring application contexts.

```kotlin
import org.junit.jupiter.api.Test;
import org.testcontainers.junit.jupiter.Container;
import org.testcontainers.junit.jupiter.Testcontainers;
import org.testcontainers.neo4j.Neo4jContainer;

import org.springframework.boot.test.context.SpringBootTest;

@Testcontainers
@SpringBootTest
class MyIntegrationTests {

	@Test
	fun myTest() {
		...
	}

	companion object {

		@Container
		@JvmStatic
		val neo4j = Neo4jContainer("neo4j:5");

	}
}
```

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

### Run with Maven and view output

Source: https://docs.spring.io/spring-boot/4.0-SNAPSHOT/tutorial/first-application/index.html

Start the application from the root project directory using Maven's spring-boot:run goal. The output shows the Spring Boot banner and a log line indicating the application started. After starting, open a browser to localhost:8080 to see the response. Press ctrl-c to exit.

```shell
$ mvn spring-boot:run

  .   ____          _            __ _ _
 /\\ / ___'_ __ _ _(_)_ __  __ _ \ \ \ \
( ( )\___ | '_ | '_| | '_ \/ _` | \ \ \ \
 \\/  ___)| |_)| | | | | || (_| |  ) ) ) )
  '  |____| .__|_| |_|_| |_\__, | / / / /
 =========|_|==============|___/=/_/_/_/
 :: Spring Boot ::  (v4.0.10-SNAPSHOT)
....... . . .
....... . . . (log output here)
....... . . .
........ Started MyApplication in 0.906 seconds (process running for 6.514)
```

```none
Hello World!
```

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

### HTTP response for trigger group overview

Source: https://docs.spring.io/spring-boot/4.0-SNAPSHOT/api/rest/actuator/quartz.html

Example response from the GET request, showing the JSON structure with trigger details for various trigger types.

```http
HTTP/1.1 200 OK
Content-Type: application/vnd.spring-boot.actuator.v3+json
Content-Length: 1233

{
  "group" : "tests",
  "paused" : false,
  "triggers" : {
    "calendarInterval" : {
      "once-a-week" : {
        "previousFireTime" : "2020-12-02T14:00:00.000Z",
        "nextFireTime" : "2020-12-08T14:00:00.000Z",
        "priority" : 5,
        "interval" : 604800000,
        "timeZone" : "Etc/UTC"
      }
    },
    "cron" : {
      "3am-week" : {
        "previousFireTime" : "2020-12-04T03:00:00.000Z",
        "nextFireTime" : "2020-12-07T03:00:00.000Z",
        "priority" : 3,
        "expression" : "0 0 3 ? * 1,2,3,4,5",
        "timeZone" : "Europe/Paris"
      }
    },
    "custom" : {
      "once-a-year-custom" : {
        "previousFireTime" : "2020-07-14T16:00:00.000Z",
        "nextFireTime" : "2021-07-14T16:00:00.000Z",
        "priority" : 10,
        "trigger" : "com.example.CustomTrigger@fdsfsd"
      }
    },
    "dailyTimeInterval" : {
      "tue-thu" : {
        "priority" : 5,
        "interval" : 3600000,
        "daysOfWeek" : [ 3, 5 ],
        "startTimeOfDay" : "09:00:00",
        "endTimeOfDay" : "18:00:00"
      }
    },
    "simple" : {
      "every-day" : {
        "nextFireTime" : "2020-12-04T12:00:00.000Z",
        "priority" : 7,
        "interval" : 86400000
      }
    }
  }
}
```

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

### startRecording()

Source: https://docs.spring.io/spring-boot/4.0-SNAPSHOT/api/java/org/springframework/boot/context/metrics/buffering/BufferingApplicationStartup.html

Starts the recording of steps and marks the beginning of the StartupTimeline. The class constructor already implicitly calls this, but it is possible to reset it as long as steps have not been recorded already.

```APIDOC
## Method: startRecording()

### Description
Starts the recording of steps and marks the beginning of the StartupTimeline. The class constructor already implicitly calls this, but it is possible to reset it as long as steps have not been recorded already.

### Throws
- **IllegalStateException** - if called and StartupStep have been recorded already.

```

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

### HTTP Response for Single Logger Group

Source: https://docs.spring.io/spring-boot/4.0-SNAPSHOT/api/rest/actuator/loggers.html

Example HTTP response for a GET request to /actuator/loggers/test. Shows the response structure with configuredLevel and members fields.

```http
HTTP/1.1 200 OK
Content-Type: application/vnd.spring-boot.actuator.v3+json
Content-Length: 82

{
  "configuredLevel" : "INFO",
  "members" : [ "test.member1", "test.member2" ]
}
```

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

### Retrieve a cache by name with curl

Source: https://docs.spring.io/spring-boot/4.0-SNAPSHOT/api/rest/actuator/caches.html

Sends a GET request to /actuator/caches/{name} to retrieve a specific cache. The example retrieves the cache named 'cities'.

```bash
$ curl 'http://localhost:8080/actuator/caches/cities' -i -X GET
```

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

### initialize

Source: https://docs.spring.io/spring-boot/4.0-SNAPSHOT/api/java/org/springframework/boot/logging/log4j2/Log4J2LoggingSystem.html

Fully initializes the logging system with the given configuration and log file.

```APIDOC
## initialize

### Description
Fully initializes the logging system.

### Method
initialize

### Signature
public void initialize(LoggingInitializationContext initializationContext, @Nullable String configLocation, @Nullable LogFile logFile)

### Parameters
- **initializationContext** (LoggingInitializationContext) - Required - The logging initialization context.
- **configLocation** (String) - Optional - A log configuration location or `null` if default initialization is required.
- **logFile** (LogFile) - Optional - The log output file that should be written or `null` for console only output.

### Returns
void
```

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

### Wildcard config tree volume example

Source: https://docs.spring.io/spring-boot/4.0-SNAPSHOT/reference/features/external-config.html

Example volume with multiple config trees under /etc/config/ for wildcard import.

```none
etc/
  config/
    dbconfig/
      db/
        username
        password
    mqconfig/
      mq/
        username
        password
```

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

### hasBean(String name) example

Source: https://docs.spring.io/spring-boot/4.0-SNAPSHOT/api/java/org/springframework/boot/test/context/assertj/ApplicationContextAssert.html

Verifies that the application context contains a bean with the given name. Throws AssertionError if the context did not start or does not contain the bean.

```java
assertThat(context).hasBean("fooBean");
```

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

### Kotlin: Create test application launcher with fromApplication()

Source: https://docs.spring.io/spring-boot/4.0-SNAPSHOT/reference/features/dev-services.html

Kotlin equivalent of the test launcher using fromApplication<MyApplication>().run(*args).

```Kotlin
import org.springframework.boot.fromApplication

fun main(args: Array<String>) {
	fromApplication<MyApplication>().run(*args)
}
```

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

### SpringApplication.logStartupInfo(ConfigurableApplicationContext context)

Source: https://docs.spring.io/spring-boot/4.0-SNAPSHOT/api/java/org/springframework/boot/SpringApplication.html

Called to log startup information, subclasses may override to add additional logging. This is a protected method.

```APIDOC
## SpringApplication.logStartupInfo(ConfigurableApplicationContext context)

### Description
Called to log startup information, subclasses may override to add additional logging. This is a protected method.

### Method
logStartupInfo (protected)

### Signature
`protected void logStartupInfo(ConfigurableApplicationContext context)`

### Parameters
- **context** (ConfigurableApplicationContext) - Required - The application context.

```

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

### Retrieve a Single SBOM with curl

Source: https://docs.spring.io/spring-boot/4.0-SNAPSHOT/api/rest/actuator/sbom.html

Use this curl command to GET /actuator/sbom/{id} and retrieve a specific SBOM. The example retrieves the SBOM named 'application'.

```bash
$ curl 'http://localhost:8080/actuator/sbom/application' -i -X GET

```

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

### doesNotHaveBean(String name) example

Source: https://docs.spring.io/spring-boot/4.0-SNAPSHOT/api/java/org/springframework/boot/test/context/assertj/ApplicationContextAssert.html

Verifies that the application context does not contain a bean with the given name. Throws AssertionError if the context did not start or contains a bean with the name.

```java
assertThat(context).doesNotHaveBean("fooBean");
```

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

### setOnStartup(boolean onStartup)

Source: https://docs.spring.io/spring-boot/4.0-SNAPSHOT/api/java/org/springframework/boot/kafka/autoconfigure/KafkaProperties.Cleanup.html

Sets whether cleanup should be performed on startup.

```APIDOC
## setOnStartup(boolean onStartup)

### Description
Sets the flag indicating whether cleanup should be performed on startup.

### Method
setOnStartup

### Signature
public void setOnStartup(boolean onStartup)

### Parameters
- **onStartup** (boolean) - Required - true to enable cleanup on startup, false to disable.

```

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

### build()

Source: https://docs.spring.io/spring-boot/4.0-SNAPSHOT/api/java/org/springframework/boot/builder/SpringApplicationBuilder.html

Returns a fully configured SpringApplication that is ready to run.

```APIDOC
## [METHOD] build()

### Description
Returns a fully configured SpringApplication that is ready to run.

### Method
`public SpringApplication build()`

### Returns
- **SpringApplication** - The fully configured SpringApplication.
```

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

### Response for GET /actuator/sbom

Source: https://docs.spring.io/spring-boot/4.0-SNAPSHOT/api/rest/actuator/sbom.html

Example HTTP response for the SBOM list request. The response includes the Content-Type header and a JSON body with an 'ids' array containing 'application'.

```http
HTTP/1.1 200 OK
Content-Type: application/vnd.spring-boot.actuator.v3+json
Content-Length: 31

{
  "ids" : [ "application" ]
}

```

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

### GET /actuator/startup

Source: https://docs.spring.io/spring-boot/4.0-SNAPSHOT/api/rest/actuator/startup.html

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

```APIDOC
## GET /actuator/startup

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

### Method
GET

### Endpoint
/actuator/startup

### Request Example
```bash
$ curl 'http://localhost:8080/actuator/startup' -i -X GET
```

### Response
#### Success Response (200)
- **springBootVersion** (String) - Spring Boot version for this application.
- **timeline.startTime** (String) - Start time of the application.
- **timeline.events** (Array) - An array of steps collected during application startup so far.
- **timeline.events.[].startTime** (String) - The timestamp of the start of this event.
- **timeline.events.[].endTime** (String) - The timestamp of the end of this event.
- **timeline.events.[].duration** (String) - The precise duration of this event.
- **timeline.events.[].startupStep.name** (String) - The name of the StartupStep.
- **timeline.events.[].startupStep.id** (Number) - The id of this StartupStep.
- **timeline.events.[].startupStep.parentId** (Number) - The parent id for this StartupStep.
- **timeline.events.[].startupStep.tags** (Array) - An array of key/value pairs with additional step info.
- **timeline.events.[].startupStep.tags[].key** (String) - The key of the StartupStep Tag.
- **timeline.events.[].startupStep.tags[].value** (String) - The value of the StartupStep Tag.

#### Response Example
```json
{
  "springBootVersion" : "4.0.10-SNAPSHOT",
  "timeline" : {
    "events" : [ {
      "duration" : "PT0.000005079S",
      "endTime" : "2026-10-21T07:25:31.243803450Z",
      "startTime" : "2026-10-21T07:25:31.243798371Z",
      "startupStep" : {
        "id" : 3,
        "name" : "spring.beans.instantiate",
        "parentId" : 2,
        "tags" : [ {
          "key" : "beanName",
          "value" : "homeController"
        } ]
      }
    }, {
      "duration" : "PT0.000017633S",
      "endTime" : "2026-10-21T07:25:31.243808309Z",
      "startTime" : "2026-10-21T07:25:31.243790676Z",
      "startupStep" : {
        "id" : 2,
        "name" : "spring.boot.application.starting",
        "tags" : [ {
          "key" : "mainApplicationClass",
          "value" : "com.example.startup.StartupApplication"
        } ]
      }
    } ],
    "startTime" : "2026-10-21T07:25:30.767276605Z"
  }
}
```
```

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

### doesNotHaveBean(Class<?> type) example

Source: https://docs.spring.io/spring-boot/4.0-SNAPSHOT/api/java/org/springframework/boot/test/context/assertj/ApplicationContextAssert.html

Verifies that the application context (or ancestors) does not contain any beans of the given type. Throws AssertionError if the context did not start or contains any beans of the type.

```java
assertThat(context).doesNotHaveBean(Foo.class);
```

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

### initialize(LoggingInitializationContext, String, LogFile)

Source: https://docs.spring.io/spring-boot/4.0-SNAPSHOT/api/java/org/springframework/boot/logging/LoggingSystem.html

Fully initializes the logging system with the given initialization context, configuration location, and log file.

```APIDOC
## initialize(LoggingInitializationContext, String, LogFile)

### Description
Fully initializes the logging system.

### Method
public void initialize(LoggingInitializationContext initializationContext, @Nullable String configLocation, @Nullable LogFile logFile)

### Parameters
- `initializationContext` (LoggingInitializationContext) - Required - The logging initialization context.
- `configLocation` (String) - Optional - A log configuration location or `null` if default initialization is required.
- `logFile` (LogFile) - Optional - The log output file that should be written or `null` for console only output.
```
Tokens:
Raw