For the latest stable version, please use Spring Boot 3.5.5!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 Gradle’s plugin portal and can be applied using the plugins block:spring-doc.cn

/*
 * Copyright 2012-present the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the License);
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

plugins {
	id 'org.springframework.boot' version '3.4.9'
}
plugins {
	id("org.springframework.boot") version "3.4.9"
}

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

plugins {
	id 'java'
	id 'org.springframework.boot' version '3.4.9'
}

apply plugin: 'io.spring.dependency-management'
plugins {
	java
	id("org.springframework.boot") version "3.4.9"
}

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