Spring Boot 4 GA

Author: antoinelochet

README.md

@@ -49,7 +49,6 @@ This is why we came up with this project.
     - [Documenting Bean Validation constraints](#documenting-bean-validation-constraints)
     - [Migrate existing Spring REST Docs tests](#migrate-existing-spring-rest-docs-tests)
         - [MockMvc based tests](#mockmvc-based-tests)
-        - [REST Assured based tests](#rest-assured-based-tests)
         - [WebTestClient based tests](#webtestclient-based-tests)
     - [Security Definitions in OpenAPI](#security-definitions-in-openapi)
     - [Running the gradle plugin](#running-the-gradle-plugin)
@@ -70,10 +69,11 @@ This is why we came up with this project.
 
 Spring Boot and Spring REST Docs 3.0.0 introduced [breaking chances to how request parameters are documented: `RequestParameterSnippet` was split into `QueryParameterSnippet` and `FormParameterSnippet`.](https://github.com/spring-projects/spring-restdocs/issues/832)
 
-|Spring Boot version | restdocs-api-spec version|
-|---|---|
-|3.x|0.17.1 or later|
-|2.x|0.16.4|
+| Spring Boot version | restdocs-api-spec version |
+|---------------------|---------------------------|
+| 4.x                 | 0.XX.X or later           |
+| 3.x                 | 0.17.1 to 0.19.4          |
+| 2.x                 | 0.16.4                    |
 
 ### Project structure
 
@@ -83,7 +83,6 @@ The project consists of the following main components:
 This is most importantly the [ResourceDocumentation](restdocs-api-spec/src/main/kotlin/com/epages/restdocs/apispec/ResourceDocumentation.kt) which is the entry point to use the extension in your tests.
 The [ResourceSnippet](restdocs-api-spec/src/main/kotlin/com/epages/restdocs/apispec/ResourceSnippet.kt) is the snippet used to produce a json file `resource.json` containing all the details about the documented resource.
 - [restdocs-api-spec-mockmvc](restdocs-api-spec-mockmvc) - contains a wrapper for `MockMvcRestDocumentation` for easier migration to `restdocs-api-spec` from MockMvc tests that use plain `spring-rest-docs-mockmvc`.
-- [restdocs-api-spec-restassured](restdocs-api-spec-restassured) - contains a wrapper for `RestAssuredRestDocumentation` for easier migration to `restdocs-api-spec` from [Rest Assured](http://rest-assured.io) tests that use plain `spring-rest-docs-restassured`.
 - [restdocs-api-spec-gradle-plugin](restdocs-api-spec-gradle-plugin) - adds a gradle plugin that aggregates the `resource.json` files produced  by `ResourceSnippet` into an API specification file for the whole project.
 
 ### Build configuration
@@ -94,7 +93,7 @@ The [ResourceSnippet](restdocs-api-spec/src/main/kotlin/com/epages/restdocs/apis
     * Using the [plugins DSL](https://docs.gradle.org/current/userguide/plugins.html#sec:plugins_block):
         ```groovy
         plugins {
-            id 'com.epages.restdocs-api-spec' version '0.18.2'
+            id 'com.epages.restdocs-api-spec' version '0.XX.X'
         }
         ```
         Examples with Kotlin are also available [here](https://plugins.gradle.org/plugin/com.epages.restdocs-api-spec)
@@ -110,7 +109,7 @@ The [ResourceSnippet](restdocs-api-spec/src/main/kotlin/com/epages/restdocs/apis
             }
           }
           dependencies {
-            classpath "com.epages:restdocs-api-spec-gradle-plugin:0.18.2" //1.2
+            classpath "com.epages:restdocs-api-spec-gradle-plugin:0.XX.X" //1.2
           }
         }
 
@@ -119,7 +118,7 @@ The [ResourceSnippet](restdocs-api-spec/src/main/kotlin/com/epages/restdocs/apis
         ```
 2. Add required dependencies to your tests
     * *2.1* add the `mavenCentral` repository used to resolve the `com.epages:restdocs-api-spec` module of the project.
-    * *2.2* add the actual `restdocs-api-spec-mockmvc` dependency to the test scope. Use `restdocs-api-spec-restassured` if you use `RestAssured` instead of `MockMvc`.
+    * *2.2* add the actual `restdocs-api-spec-mockmvc` dependency to the test scope.
     * *2.3* add configuration options for `restdocs-api-spec-gradle-plugin`. See [Gradle plugin configuration](#gradle-plugin-configuration)
     ```groovy
 
@@ -129,7 +128,7 @@ The [ResourceSnippet](restdocs-api-spec/src/main/kotlin/com/epages/restdocs/apis
 
     dependencies {
         //..
-        testImplementation('com.epages:restdocs-api-spec-mockmvc:0.18.2') //2.2
+        testImplementation('com.epages:restdocs-api-spec-mockmvc:0.XX.X') //2.2
     }
 
     openapi { //2.3
@@ -298,30 +297,6 @@ resultActions
 This will do exactly what `MockMvcRestDocumentation.document` does.
 Additionally it will add a `ResourceSnippet` with the descriptors you provided in the `RequestFieldsSnippet`, `ResponseFieldsSnippet`, and `LinksSnippet`.
 
-#### REST Assured based tests
-
-Also for REST Assured we offer a convenience wrapper similar to `MockMvcRestDocumentationWrapper`.
-The usage for REST Assured is also similar to MockMVC, except that [com.epages.restdocs.apispec.RestAssuredRestDocumentationWrapper](restdocs-api-spec/src/main/kotlin/com/epages/restdocs/apispec/RestAssuredRestDocumentationWrapper.kt) is used instead of [com.epages.restdocs.apispec.MockMvcRestDocumentationWrapper](restdocs-api-spec/src/main/kotlin/com/epages/restdocs/apispec/MockMvcRestDocumentationWrapper.kt).
-
-To use the `RestAssuredRestDocumentationWrapper`, you have to add a dependency to [restdocs-api-spec-restassured](restdocs-api-spec-restassured) to your build.
-```java
-RestAssured.given(this.spec)
-        .filter(RestAssuredRestDocumentationWrapper.document("{method-name}",
-                "The API description",
-                requestParameters(
-                        parameterWithName("param").description("the param")
-                ),
-                responseFields(
-                        fieldWithPath("doc.timestamp").description("Creation timestamp")
-                )
-        ))
-        .when()
-        .queryParam("param", "foo")
-        .get("/restAssuredExample")
-        .then()
-        .statusCode(200);
-```
-
 #### WebTestClient based tests
 
 We also offer a convenience wrapper for `WebTestClient` which works similar to `MockMvcRestDocumentationWrapper`.
@@ -586,7 +561,7 @@ Given that the `master` branch on the upstream repository is in the state from w
 
 [Create release via the GitHub UI](https://github.com/ePages-de/restdocs-api-spec/releases/new).
 
-Use the intended version number as "Tag version", e.g. "0.18.2".
+Use the intended version number as "Tag version", e.g. "0.XX.X".
 This will automatically trigger a GitHub Action build which publishes the JAR files for this release to Sonatype.
 
 **(2) Login to Sonatype**

build.gradle.kts

@@ -1,7 +1,9 @@
 
+import org.gradle.kotlin.dsl.withType
 import org.jetbrains.kotlin.gradle.dsl.JvmTarget
 import org.jetbrains.kotlin.gradle.tasks.KotlinCompile
 import org.jmailen.gradle.kotlinter.tasks.LintTask
+import org.springframework.boot.gradle.tasks.bundling.BootJar
 import pl.allegro.tech.build.axion.release.domain.TagNameSerializationConfig
 import pl.allegro.tech.build.axion.release.domain.hooks.HooksConfig
 
@@ -15,6 +17,7 @@ plugins {
     jacoco
     java
     kotlin("jvm") version "2.2.21" apply false
+    id("org.springframework.boot") version "4.0.0"
 }
 
 repositories {
@@ -66,13 +69,6 @@ allprojects {
 
 subprojects {
 
-    val jacksonVersion by extra { "3.0.2" }
-    val jackson2Version by extra { "2.20.1" }
-    val jacksonAnnotationsVersion by extra { "2.20" }
-    val springBootVersion by extra { "4.0.0-RC2" }
-    val springRestDocsVersion by extra { "4.0.0-RC1" }
-    val springRestDocsRestAssuredVersion by extra { "4.0.0-M3" }
-    val junitVersion by extra { "6.0.1" }
     val jmustacheVersion by extra { "1.16" }
 
     tasks.withType<KotlinCompile> {
@@ -154,3 +150,7 @@ sonar {
         property("sonar.exclusions", "**/samples/**")
     }
 }
+
+tasks.withType<BootJar> {
+    enabled = false
+}

gradle/gradle-daemon-jvm.properties

@@ -0,0 +1,2 @@
+#This file is generated by updateDaemonJvm
+toolchainVersion=21

restdocs-api-spec-gradle-plugin/build.gradle.kts

@@ -1,3 +1,6 @@
+import io.spring.gradle.dependencymanagement.dsl.DependencyManagementExtension
+import kotlin.apply
+
 repositories {
     mavenCentral()
 }
@@ -9,6 +12,13 @@ plugins {
     id("com.gradle.plugin-publish") version "0.21.0"
 }
 
+apply(plugin = "io.spring.dependency-management")
+the<DependencyManagementExtension>().apply {
+    imports {
+        mavenBom(org.springframework.boot.gradle.plugin.SpringBootPlugin.BOM_COORDINATES)
+    }
+}
+
 gradlePlugin {
     plugins {
         register("com.epages.restdocs-api-spec") {
@@ -36,9 +46,6 @@ pluginBundle {
     }
 }
 
-val jacksonVersion: String by extra
-val junitVersion: String by extra
-
 val jacocoRuntime by configurations.creating
 
 dependencies {
@@ -50,14 +57,14 @@ dependencies {
     implementation(project(":restdocs-api-spec-openapi-generator"))
     implementation(project(":restdocs-api-spec-openapi3-generator"))
     implementation(project(":restdocs-api-spec-postman-generator"))
-    implementation("tools.jackson.core:jackson-databind:$jacksonVersion")
-    implementation("tools.jackson.module:jackson-module-kotlin:$jacksonVersion")
-    implementation("tools.jackson.dataformat:jackson-dataformat-yaml:$jacksonVersion")
+    implementation("tools.jackson.core:jackson-databind")
+    implementation("tools.jackson.module:jackson-module-kotlin")
+    implementation("tools.jackson.dataformat:jackson-dataformat-yaml")
 
-    testImplementation("org.junit.jupiter:junit-jupiter-engine:$junitVersion")
+    testImplementation("org.junit.jupiter:junit-jupiter-engine")
     testRuntimeOnly("org.junit.platform:junit-platform-launcher")
     testImplementation("org.junit-pioneer:junit-pioneer:2.3.0")
-    testImplementation("org.assertj:assertj-core:3.27.6")
+    testImplementation("org.assertj:assertj-core")
 
     testImplementation("com.jayway.jsonpath:json-path:2.10.0")
 

restdocs-api-spec-jsonschema/build.gradle.kts

@@ -1,3 +1,6 @@
+import io.spring.gradle.dependencymanagement.dsl.DependencyManagementExtension
+import kotlin.apply
+
 plugins {
     kotlin("jvm")
     signing
@@ -7,21 +10,25 @@ repositories {
     mavenCentral()
 }
 
-val jacksonVersion: String by extra
-val junitVersion: String by extra
+apply(plugin = "io.spring.dependency-management")
+the<DependencyManagementExtension>().apply {
+    imports {
+        mavenBom(org.springframework.boot.gradle.plugin.SpringBootPlugin.BOM_COORDINATES)
+    }
+}
 
 dependencies {
     implementation(kotlin("stdlib-jdk8"))
     implementation(project(":restdocs-api-spec-model"))
     implementation("com.github.erosb:everit-json-schema:1.11.0")
-    implementation("tools.jackson.core:jackson-databind:$jacksonVersion")
-    implementation("tools.jackson.module:jackson-module-kotlin:$jacksonVersion")
+    implementation("tools.jackson.core:jackson-databind")
+    implementation("tools.jackson.module:jackson-module-kotlin")
 
-    testImplementation("org.junit.jupiter:junit-jupiter-engine:$junitVersion")
+    testImplementation("org.junit.jupiter:junit-jupiter-engine")
     testRuntimeOnly("org.junit.platform:junit-platform-launcher")
     testImplementation("com.github.java-json-tools:json-schema-validator:2.2.14")
     testImplementation("com.jayway.jsonpath:json-path:2.10.0")
-    testImplementation("org.assertj:assertj-core:3.27.6")
+    testImplementation("org.assertj:assertj-core")
     testImplementation("javax.validation:validation-api:2.0.1.Final")
 }
 

restdocs-api-spec-mockmvc/build.gradle.kts

@@ -1,3 +1,6 @@
+import io.spring.gradle.dependencymanagement.dsl.DependencyManagementExtension
+import kotlin.apply
+
 plugins {
     kotlin("jvm")
     signing
@@ -7,25 +10,28 @@ repositories {
     mavenCentral()
 }
 
-val springBootVersion: String by extra
-val springRestDocsVersion: String by extra
-val junitVersion: String by extra
+apply(plugin = "io.spring.dependency-management")
+the<DependencyManagementExtension>().apply {
+    imports {
+        mavenBom(org.springframework.boot.gradle.plugin.SpringBootPlugin.BOM_COORDINATES)
+    }
+}
 
 dependencies {
     implementation(kotlin("stdlib-jdk8"))
 
     api(project(":restdocs-api-spec"))
-    implementation("org.springframework.restdocs:spring-restdocs-mockmvc:$springRestDocsVersion")
+    implementation("org.springframework.restdocs:spring-restdocs-mockmvc")
 
-    testImplementation("org.springframework.boot:spring-boot-starter-test:$springBootVersion")
-    testImplementation("org.springframework.boot:spring-boot-starter-webmvc-test:$springBootVersion")
-    testImplementation("org.springframework.boot:spring-boot-restdocs:$springBootVersion")
-    testImplementation("org.springframework.boot:spring-boot-starter-validation:$springBootVersion")
-    testImplementation("org.junit.jupiter:junit-jupiter-engine:$junitVersion")
+    testImplementation("org.springframework.boot:spring-boot-starter-test")
+    testImplementation("org.springframework.boot:spring-boot-starter-webmvc-test")
+    testImplementation("org.springframework.boot:spring-boot-restdocs")
+    testImplementation("org.springframework.boot:spring-boot-starter-validation")
+    testImplementation("org.junit.jupiter:junit-jupiter-engine")
     testRuntimeOnly("org.junit.platform:junit-platform-launcher")
     testImplementation("org.junit-pioneer:junit-pioneer:2.3.0")
     testImplementation(testFixtures(project(":restdocs-api-spec")))
-    testImplementation("org.springframework.boot:spring-boot-starter-hateoas:$springBootVersion")
+    testImplementation("org.springframework.boot:spring-boot-starter-hateoas")
 }
 
 publishing {

restdocs-api-spec-model/build.gradle.kts

@@ -1,5 +1,5 @@
-val jacksonVersion: String by extra
-val jacksonAnnotationsVersion: String by extra
+import io.spring.gradle.dependencymanagement.dsl.DependencyManagementExtension
+import kotlin.apply
 
 plugins {
     kotlin("jvm")
@@ -10,9 +10,16 @@ repositories {
     mavenCentral()
 }
 
+apply(plugin = "io.spring.dependency-management")
+the<DependencyManagementExtension>().apply {
+    imports {
+        mavenBom(org.springframework.boot.gradle.plugin.SpringBootPlugin.BOM_COORDINATES)
+    }
+}
+
 dependencies {
     implementation(kotlin("stdlib-jdk8"))
-    implementation("com.fasterxml.jackson.core:jackson-annotations:$jacksonAnnotationsVersion")
+    implementation("com.fasterxml.jackson.core:jackson-annotations")
 }
 
 publishing {

restdocs-api-spec-openapi-generator/build.gradle.kts

@@ -1,3 +1,6 @@
+import io.spring.gradle.dependencymanagement.dsl.DependencyManagementExtension
+import kotlin.apply
+
 plugins {
     kotlin("jvm")
     signing
@@ -7,25 +10,28 @@ repositories {
     mavenCentral()
 }
 
-val junitVersion: String by extra
-val jacksonVersion: String by extra
-val springBootVersion: String by extra
+apply(plugin = "io.spring.dependency-management")
+the<DependencyManagementExtension>().apply {
+    imports {
+        mavenBom(org.springframework.boot.gradle.plugin.SpringBootPlugin.BOM_COORDINATES)
+    }
+}
 
 dependencies {
     implementation(kotlin("stdlib-jdk8"))
 
     api(project(":restdocs-api-spec-model"))
     api(project(":restdocs-api-spec-jsonschema"))
     api("io.swagger:swagger-core:1.6.16")
-    implementation("org.springframework.boot:spring-boot-jackson2:$springBootVersion")
-    implementation("tools.jackson.core:jackson-databind:$jacksonVersion")
-    implementation("tools.jackson.module:jackson-module-kotlin:$jacksonVersion")
-    implementation("tools.jackson.dataformat:jackson-dataformat-yaml:$jacksonVersion")
+    implementation("org.springframework.boot:spring-boot-jackson2")
+    implementation("tools.jackson.core:jackson-databind")
+    implementation("tools.jackson.module:jackson-module-kotlin")
+    implementation("tools.jackson.dataformat:jackson-dataformat-yaml")
 
     testImplementation("io.swagger:swagger-parser:1.0.75")
-    testImplementation("org.junit.jupiter:junit-jupiter-engine:$junitVersion")
+    testImplementation("org.junit.jupiter:junit-jupiter-engine")
     testRuntimeOnly("org.junit.platform:junit-platform-launcher")
-    testImplementation("org.assertj:assertj-core:3.27.6")
+    testImplementation("org.assertj:assertj-core")
 }
 
 publishing {