Restore support for REST Assured

Closes gh-784

Author: wilkinsona

build.gradle

@@ -117,6 +117,7 @@ subprojects { subproject ->
 samples {
 	dependOn "spring-restdocs-core:publishToMavenLocal"
 	dependOn "spring-restdocs-mockmvc:publishToMavenLocal"
+	dependOn "spring-restdocs-restassured:publishToMavenLocal"
 	dependOn "spring-restdocs-webtestclient:publishToMavenLocal"
 	dependOn "spring-restdocs-asciidoctor:publishToMavenLocal"
 
@@ -132,6 +133,10 @@ samples {
 		workingDir "$projectDir/samples/testng"
 	}
 
+	restAssured {
+		workingDir "$projectDir/samples/rest-assured"
+	}
+
 	webTestClient {
 		workingDir "$projectDir/samples/web-test-client"
 	}

docs/build.gradle

@@ -19,6 +19,7 @@ dependencies {
 	internal(enforcedPlatform("org.springframework:spring-framework-bom:$springFrameworkVersion"))
 
 	testImplementation(project(":spring-restdocs-mockmvc"))
+	testImplementation(project(":spring-restdocs-restassured"))
 	testImplementation(project(":spring-restdocs-webtestclient"))
 	testImplementation("jakarta.validation:jakarta.validation-api")
 	testImplementation("junit:junit")

docs/src/docs/asciidoc/configuration.adoc

@@ -45,6 +45,17 @@ TIP: To configure a request's context path, use the `contextPath` method on `Moc
 
 
 
+[[configuration-uris-rest-assured]]
+==== REST Assured URI Customization
+
+REST Assured tests a service by making actual HTTP requests. As a result, URIs must be
+customized once the operation on the service has been performed but before it is
+documented. A
+<<customizing-requests-and-responses-preprocessors-modify-uris, REST-Assured-specific
+preprocessor>> is provided for this purpose.
+
+
+
 [[configuration-uris-webtestclient]]
 ==== WebTestClient URI Customization
 
@@ -79,6 +90,12 @@ include::{examples-dir}/com/example/mockmvc/CustomEncoding.java[tags=custom-enco
 include::{examples-dir}/com/example/webtestclient/CustomEncoding.java[tags=custom-encoding]
 ----
 
+[source,java,indent=0,role="secondary"]
+.REST Assured
+----
+include::{examples-dir}/com/example/restassured/CustomEncoding.java[tags=custom-encoding]
+----
+
 TIP: When Spring REST Docs converts the content of a request or a response to a `String`, the `charset` specified in the `Content-Type` header is used if it is available.
 In its absence, the JVM's default `Charset` is used.
 You can configure the JVM's default `Charset` by using the `file.encoding` system property.
@@ -105,6 +122,13 @@ include::{examples-dir}/com/example/mockmvc/CustomFormat.java[tags=custom-format
 include::{examples-dir}/com/example/webtestclient/CustomFormat.java[tags=custom-format]
 ----
 
+[source,java,indent=0,role="secondary"]
+.REST Assured
+----
+include::{examples-dir}/com/example/restassured/CustomFormat.java[tags=custom-format]
+----
+====
+
 
 
 [[configuration-default-snippets]]
@@ -134,6 +158,12 @@ include::{examples-dir}/com/example/mockmvc/CustomDefaultSnippets.java[tags=cust
 include::{examples-dir}/com/example/webtestclient/CustomDefaultSnippets.java[tags=custom-default-snippets]
 ----
 
+[source,java,indent=0,role="secondary"]
+.REST Assured
+----
+include::{examples-dir}/com/example/restassured/CustomDefaultSnippets.java[tags=custom-default-snippets]
+----
+
 
 
 [[configuration-default-preprocessors]]
@@ -158,4 +188,10 @@ include::{examples-dir}/com/example/webtestclient/CustomDefaultOperationPreproce
 <1> Apply a request preprocessor that removes the header named `Foo`.
 <2> Apply a response preprocessor that pretty prints its content.
 
-
+[source,java,indent=0,role="secondary"]
+.REST Assured
+----
+include::{examples-dir}/com/example/restassured/CustomDefaultOperationPreprocessors.java[tags=custom-default-operation-preprocessors]
+----
+<1> Apply a request preprocessor that removes the header named `Foo`.
+<2> Apply a response preprocessor that pretty prints its content.

docs/src/docs/asciidoc/customizing-requests-and-responses.adoc

@@ -24,6 +24,14 @@ include::{examples-dir}/com/example/webtestclient/PerTestPreprocessing.java[tags
 <1> Apply a request preprocessor that removes the header named `Foo`.
 <2> Apply a response preprocessor that pretty prints its content.
 
+.REST Assured
+----
+include::{examples-dir}/com/example/restassured/PerTestPreprocessing.java[tags=preprocessing]
+----
+<1> Apply a request preprocessor that removes the header named `Foo`.
+<2> Apply a response preprocessor that pretty prints its content.
+====
+
 Alternatively, you may want to apply the same preprocessors to every test.
 You can do so by using the `RestDocumentationConfigurer` API in your `@Before` method to configure the preprocessors.
 For example, to remove the `Foo` header from all requests and pretty print all responses, you could do one of the following (depending on your testing environment):
@@ -44,6 +52,14 @@ include::{examples-dir}/com/example/webtestclient/EveryTestPreprocessing.java[ta
 <1> Apply a request preprocessor that removes the header named `Foo`.
 <2> Apply a response preprocessor that pretty prints its content.
 
+[source,java,indent=0,role="secondary"]
+.REST Assured
+----
+include::{examples-dir}/com/example/restassured/EveryTestPreprocessing.java[tags=setup]
+----
+<1> Apply a request preprocessor that removes the header named `Foo`.
+<2> Apply a response preprocessor that pretty prints its content.
+
 Then, in each test, you can perform any configuration specific to that test.
 The following examples show how to do so:
 
@@ -59,6 +75,12 @@ include::{examples-dir}/com/example/mockmvc/EveryTestPreprocessing.java[tags=use
 include::{examples-dir}/com/example/webtestclient/EveryTestPreprocessing.java[tags=use]
 ----
 
+[source,java,indent=0,role="secondary"]
+.REST Assured
+----
+include::{examples-dir}/com/example/restassured/EveryTestPreprocessing.java[tags=use]
+----
+
 Various built-in preprocessors, including those illustrated above, are available through the static methods on `Preprocessors`.
 See <<Preprocessors, below>> for further details.
 
@@ -116,7 +138,7 @@ You can use `modifyParameters` on `Preprocessors` to add, set, and remove reques
 TIP: If you use MockMvc or a WebTestClient that is not bound to a server, you should customize URIs by <<configuration-uris, changing the configuration>>.
 
 You can use `modifyUris` on `Preprocessors` to modify any URIs in a request or a response.
-When using WebTestClient bound to a server, this lets you customize the URIs that appear in the documentation while testing a local instance of the service.
+When using REST Assured or WebTestClient bound to a server, this lets you customize the URIs that appear in the documentation while testing a local instance of the service.