This version is still in development and is not considered stable yet. For the latest stable version, please use Spring Boot 3.4.0!spring-doc.cn

Getting Started

To get started with the plugin it needs to be applied to your project.spring-doc.cn

The plugin is published to the Spring snapshots repository. Gradle can be configured to use the snapshots repository and the plugin can then be applied using the plugins block. To configure Gradle to use the snapshots repository, add the following to your settings.gradle (Groovy) or settings.gradle.kts (Kotlin):spring-doc.cn

Groovyspring-doc.cn
Kotlinspring-doc.cn

pluginManagement {
	repositories {
		maven { url 'https://repo.spring.io/milestone' }
		maven { url 'https://repo.spring.io/snapshot' }
		gradlePluginPortal()
	}
}

pluginManagement {
	repositories {
		maven { url = uri("https://repo.spring.io/milestone") }
		maven { url = uri("https://repo.spring.io/snapshot") }
		gradlePluginPortal()
	}
}

The plugin can then be applied using the plugins block:spring-doc.cn

Groovyspring-doc.cn
Kotlinspring-doc.cn

plugins {
	id 'org.springframework.boot' version '3.3.7-SNAPSHOT'
}

plugins {
	id("org.springframework.boot") version "3.3.7-SNAPSHOT"
}

Applied in isolation the plugin makes few changes to a project. Instead, the plugin detects when certain other plugins are applied and reacts accordingly. For example, when the java plugin is applied a task for building an executable jar is automatically configured. A typical Spring Boot project will apply the groovy, java, or org.jetbrains.kotlin.jvm plugin as a minimum and also use the io.spring.dependency-management plugin or Gradle’s native bom support for dependency management. For example:spring-doc.cn

Groovyspring-doc.cn
Kotlinspring-doc.cn

plugins {
	id 'java'
	id 'org.springframework.boot' version '3.3.7-SNAPSHOT'
}

apply plugin: 'io.spring.dependency-management'

plugins {
	java
	id("org.springframework.boot") version "3.3.7-SNAPSHOT"
}

apply(plugin = "io.spring.dependency-management")

To learn more about how the Spring Boot plugin behaves when other plugins are applied please see the section on reacting to other plugins.spring-doc.cn