springboot-plugins

---

Plugin created with the aim of facilitating and speeding up the process of configuring and initializing modularized projects that use Spring Boot. By default, all plugin settings are based on the project using Kotlin, but also giving the option to also use Java or both.

---

Requires

• Java 21
• Kotlin 2.0.0
• Gradle 8.5

Usage

• OpenAPI Generator

Current Version

• gradle.properties

---

Setup

---

At the top of settings.gradle.kts from the root project, add the classpath configuration.

buildscript {
    repositories {
        mavenLocal()
        mavenCentral()
        gradlePluginPortal()
        maven("https://jitpack.io")
        maven("https://repo.spring.io/milestone")
    }

    dependencies {
        classpath("com.github.softwareplace.springboot:plugins:{version}")
    }
}

After creating the build.gradle.kts file, add it to configure the project as shown in the example below

Configuration example

Kotlin configuration

import com.github.softwareplace.springboot.kotlin.kotlinMapStruct
import com.github.softwareplace.springboot.kotlin.kotlinReactive
import com.github.softwareplace.springboot.kotlin.openapi.kotlinOpenApiSettings
import com.github.softwareplace.springboot.kotlin.testKotlinMockito
import com.github.softwareplace.springboot.utils.jsonLogger
import com.github.softwareplace.springboot.utils.springBootStartWeb
import com.github.softwareplace.springboot.utils.springJettyApi


plugins {
    id("com.github.softwareplace.springboot.kotlin")
}

group = "com.spring.example.openapi"
version = "1.0.0"

// Used for submodules that no needs bootJar, bootRun tasks.
// submoduleConfig()
    
kotlinOpenApiSettings()

dependencies {
    kotlinReactive()
    springJettyApi()
    kotlinMapStruct()
    springBootStartWeb()

    testKotlinMockito()
}

Java project configuration

import com.github.softwareplace.springboot.java.javaMapStruct
import com.github.softwareplace.springboot.java.lombok
import com.github.softwareplace.springboot.java.openapi.javaOpenApiSettings
import com.github.softwareplace.springboot.utils.springWebFlux
import com.github.softwareplace.springboot.utils.testMockito

plugins {
    id("com.github.softwareplace.springboot.java")
}

// Access a values declared on gradle.properties
// val springBootVersion: String by project

// Used for submodules that no needs bootJar, bootRun tasks.
// submoduleConfig()

javaOpenApiSettings {
    // Override the current generated model anotation. 
    overrideAllAdditionalModelTypeAnnotations = true
    additionalModelTypeAnnotations = listOf(
        lombokBuilder,
        lombokData,
        lombokAllArgsConstructor
    )
}

dependencies {
    lombok()
    springWebFlux()
    javaMapStruct()

    testMockito()
}

Submodule configuration

By working with modular projects, the example above will work for a submodule as well. If the submodule requires a Spring Boot dependency, on build.gradle.kts add submoduleConfig(). By running this method, bootJar and bootRun tasks will be disabled and some unused open API generated files will be ignored.

• For more example, see some implementation example

---

This project is open-source and free for usage.

Contributing

---

We welcome contributions from the community. If you would like to contribute, please take time to familiarise yourself with our Contribution Guidelines.

Let's make something amazing together!

License

---

The builder-plugin is Open Source software released under the LICENSE file in the project root.