Restore support for REST Assured

Closes gh-784

docs/src/test/java/com/example/restassured/CustomDefaultOperationPreprocessors.java

@@ -0,0 +1,49 @@
+/*
+ * Copyright 2014-2021 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.
+ */
+
+package com.example.restassured;
+
+import io.restassured.builder.RequestSpecBuilder;
+import io.restassured.specification.RequestSpecification;
+import org.junit.Before;
+import org.junit.Rule;
+
+import org.springframework.restdocs.JUnitRestDocumentation;
+
+import static org.springframework.restdocs.operation.preprocess.Preprocessors.prettyPrint;
+import static org.springframework.restdocs.operation.preprocess.Preprocessors.removeHeaders;
+import static org.springframework.restdocs.restassured.RestAssuredRestDocumentation.documentationConfiguration;
+
+public class CustomDefaultOperationPreprocessors {
+
+	@Rule
+	public final JUnitRestDocumentation restDocumentation = new JUnitRestDocumentation();
+
+	@SuppressWarnings("unused")
+	private RequestSpecification spec;
+
+	@Before
+	public void setup() {
+		// tag::custom-default-operation-preprocessors[]
+		this.spec = new RequestSpecBuilder()
+				.addFilter(documentationConfiguration(this.restDocumentation).operationPreprocessors()
+						.withRequestDefaults(removeHeaders("Foo")) // <1>
+						.withResponseDefaults(prettyPrint())) // <2>
+				.build();
+		// end::custom-default-operation-preprocessors[]
+	}
+
+}

docs/src/test/java/com/example/restassured/CustomDefaultSnippets.java

@@ -0,0 +1,46 @@
+/*
+ * Copyright 2014-2021 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.
+ */
+
+package com.example.restassured;
+
+import io.restassured.builder.RequestSpecBuilder;
+import io.restassured.specification.RequestSpecification;
+import org.junit.Before;
+import org.junit.Rule;
+
+import org.springframework.restdocs.JUnitRestDocumentation;
+
+import static org.springframework.restdocs.cli.CliDocumentation.curlRequest;
+import static org.springframework.restdocs.restassured.RestAssuredRestDocumentation.documentationConfiguration;
+
+public class CustomDefaultSnippets {
+
+	@Rule
+	public final JUnitRestDocumentation restDocumentation = new JUnitRestDocumentation();
+
+	@SuppressWarnings("unused")
+	private RequestSpecification spec;
+
+	@Before
+	public void setUp() {
+		// tag::custom-default-snippets[]
+		this.spec = new RequestSpecBuilder()
+				.addFilter(documentationConfiguration(this.restDocumentation).snippets().withDefaults(curlRequest()))
+				.build();
+		// end::custom-default-snippets[]
+	}
+
+}

docs/src/test/java/com/example/restassured/CustomEncoding.java

@@ -0,0 +1,45 @@
+/*
+ * Copyright 2014-2021 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.
+ */
+
+package com.example.restassured;
+
+import io.restassured.builder.RequestSpecBuilder;
+import io.restassured.specification.RequestSpecification;
+import org.junit.Before;
+import org.junit.Rule;
+
+import org.springframework.restdocs.JUnitRestDocumentation;
+
+import static org.springframework.restdocs.restassured.RestAssuredRestDocumentation.documentationConfiguration;
+
+public class CustomEncoding {
+
+	@Rule
+	public final JUnitRestDocumentation restDocumentation = new JUnitRestDocumentation();
+
+	@SuppressWarnings("unused")
+	private RequestSpecification spec;
+
+	@Before
+	public void setUp() {
+		// tag::custom-encoding[]
+		this.spec = new RequestSpecBuilder()
+				.addFilter(documentationConfiguration(this.restDocumentation).snippets().withEncoding("ISO-8859-1"))
+				.build();
+		// end::custom-encoding[]
+	}
+
+}

docs/src/test/java/com/example/restassured/CustomFormat.java

@@ -0,0 +1,45 @@
+/*
+ * Copyright 2014-2021 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.
+ */
+
+package com.example.restassured;
+
+import io.restassured.builder.RequestSpecBuilder;
+import io.restassured.specification.RequestSpecification;
+import org.junit.Before;
+import org.junit.Rule;
+
+import org.springframework.restdocs.JUnitRestDocumentation;
+import org.springframework.restdocs.templates.TemplateFormats;
+
+import static org.springframework.restdocs.restassured.RestAssuredRestDocumentation.documentationConfiguration;
+
+public class CustomFormat {
+
+	@Rule
+	public final JUnitRestDocumentation restDocumentation = new JUnitRestDocumentation();
+
+	@SuppressWarnings("unused")
+	private RequestSpecification spec;
+
+	@Before
+	public void setUp() {
+		// tag::custom-format[]
+		this.spec = new RequestSpecBuilder().addFilter(documentationConfiguration(this.restDocumentation).snippets()
+				.withTemplateFormat(TemplateFormats.markdown())).build();
+		// end::custom-format[]
+	}
+
+}

docs/src/test/java/com/example/restassured/EveryTestPreprocessing.java

@@ -0,0 +1,61 @@
+/*
+ * Copyright 2014-2021 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.
+ */
+
+package com.example.restassured;
+
+import io.restassured.RestAssured;
+import io.restassured.builder.RequestSpecBuilder;
+import io.restassured.specification.RequestSpecification;
+import org.junit.Before;
+import org.junit.Rule;
+
+import org.springframework.restdocs.JUnitRestDocumentation;
+
+import static org.hamcrest.CoreMatchers.is;
+import static org.springframework.restdocs.hypermedia.HypermediaDocumentation.linkWithRel;
+import static org.springframework.restdocs.hypermedia.HypermediaDocumentation.links;
+import static org.springframework.restdocs.operation.preprocess.Preprocessors.prettyPrint;
+import static org.springframework.restdocs.operation.preprocess.Preprocessors.removeHeaders;
+import static org.springframework.restdocs.restassured.RestAssuredRestDocumentation.document;
+import static org.springframework.restdocs.restassured.RestAssuredRestDocumentation.documentationConfiguration;
+
+public class EveryTestPreprocessing {
+
+	@Rule
+	public final JUnitRestDocumentation restDocumentation = new JUnitRestDocumentation();
+
+	// tag::setup[]
+	private RequestSpecification spec;
+
+	@Before
+	public void setup() {
+		this.spec = new RequestSpecBuilder()
+				.addFilter(documentationConfiguration(this.restDocumentation).operationPreprocessors()
+						.withRequestDefaults(removeHeaders("Foo")) // <1>
+						.withResponseDefaults(prettyPrint())) // <2>
+				.build();
+	}
+	// end::setup[]
+
+	public void use() throws Exception {
+		// tag::use[]
+		RestAssured.given(this.spec)
+				.filter(document("index", links(linkWithRel("self").description("Canonical self link")))).when()
+				.get("/").then().assertThat().statusCode(is(200));
+		// end::use[]
+	}
+
+}

docs/src/test/java/com/example/restassured/ExampleApplicationJUnit5Tests.java

@@ -0,0 +1,43 @@
+/*
+ * Copyright 2014-2021 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.
+ */
+
+package com.example.restassured;
+
+import io.restassured.builder.RequestSpecBuilder;
+import io.restassured.specification.RequestSpecification;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.extension.ExtendWith;
+
+import org.springframework.restdocs.RestDocumentationContextProvider;
+import org.springframework.restdocs.RestDocumentationExtension;
+
+import static org.springframework.restdocs.restassured.RestAssuredRestDocumentation.documentationConfiguration;
+
+@ExtendWith(RestDocumentationExtension.class)
+public class ExampleApplicationJUnit5Tests {
+
+	@SuppressWarnings("unused")
+	// tag::setup[]
+	private RequestSpecification spec;
+
+	@BeforeEach
+	public void setUp(RestDocumentationContextProvider restDocumentation) {
+		this.spec = new RequestSpecBuilder().addFilter(documentationConfiguration(restDocumentation)) // <1>
+				.build();
+	}
+	// end::setup[]
+
+}

docs/src/test/java/com/example/restassured/ExampleApplicationTestNgTests.java

@@ -0,0 +1,53 @@
+/*
+ * Copyright 2014-2021 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.
+ */
+
+package com.example.restassured;
+
+import java.lang.reflect.Method;
+
+import io.restassured.builder.RequestSpecBuilder;
+import io.restassured.specification.RequestSpecification;
+import org.testng.annotations.AfterMethod;
+import org.testng.annotations.BeforeMethod;
+
+import org.springframework.restdocs.ManualRestDocumentation;
+
+import static org.springframework.restdocs.restassured.RestAssuredRestDocumentation.documentationConfiguration;
+
+public class ExampleApplicationTestNgTests {
+
+	private final ManualRestDocumentation restDocumentation = new ManualRestDocumentation();
+
+	@SuppressWarnings("unused")
+	// tag::setup[]
+	private RequestSpecification spec;
+
+	@BeforeMethod
+	public void setUp(Method method) {
+		this.spec = new RequestSpecBuilder().addFilter(documentationConfiguration(this.restDocumentation)).build();
+		this.restDocumentation.beforeTest(getClass(), method.getName());
+	}
+
+	// end::setup[]
+
+	// tag::teardown[]
+	@AfterMethod
+	public void tearDown() {
+		this.restDocumentation.afterTest();
+	}
+	// end::teardown[]
+
+}

docs/src/test/java/com/example/restassured/ExampleApplicationTests.java

@@ -0,0 +1,44 @@
+/*
+ * Copyright 2014-2021 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.
+ */
+
+package com.example.restassured;
+
+import io.restassured.builder.RequestSpecBuilder;
+import io.restassured.specification.RequestSpecification;
+import org.junit.Before;
+import org.junit.Rule;
+
+import org.springframework.restdocs.JUnitRestDocumentation;
+
+import static org.springframework.restdocs.restassured.RestAssuredRestDocumentation.documentationConfiguration;
+
+public class ExampleApplicationTests {
+
+	@Rule
+	public final JUnitRestDocumentation restDocumentation = new JUnitRestDocumentation();
+
+	@SuppressWarnings("unused")
+	// tag::setup[]
+	private RequestSpecification spec;
+
+	@Before
+	public void setUp() {
+		this.spec = new RequestSpecBuilder().addFilter(documentationConfiguration(this.restDocumentation)) // <1>
+				.build();
+	}
+	// end::setup[]
+
+}

docs/src/test/java/com/example/restassured/HttpHeaders.java

@@ -0,0 +1,48 @@
+/*
+ * Copyright 2014-2021 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.
+ */
+
+package com.example.restassured;
+
+import io.restassured.RestAssured;
+import io.restassured.specification.RequestSpecification;
+
+import static org.hamcrest.CoreMatchers.is;
+import static org.springframework.restdocs.headers.HeaderDocumentation.headerWithName;
+import static org.springframework.restdocs.headers.HeaderDocumentation.requestHeaders;
+import static org.springframework.restdocs.headers.HeaderDocumentation.responseHeaders;
+import static org.springframework.restdocs.restassured.RestAssuredRestDocumentation.document;
+
+public class HttpHeaders {
+
+	private RequestSpecification spec;
+
+	public void headers() throws Exception {
+		// tag::headers[]
+		RestAssured.given(this.spec).filter(document("headers", requestHeaders(// <1>
+				headerWithName("Authorization").description("Basic auth credentials")), // <2>
+				responseHeaders(// <3>
+						headerWithName("X-RateLimit-Limit")
+								.description("The total number of requests permitted per period"),
+						headerWithName("X-RateLimit-Remaining")
+								.description("Remaining requests permitted in current period"),
+						headerWithName("X-RateLimit-Reset")
+								.description("Time at which the rate limit period will reset"))))
+				.header("Authorization", "Basic dXNlcjpzZWNyZXQ=") // <4>
+				.when().get("/people").then().assertThat().statusCode(is(200));
+		// end::headers[]
+	}
+
+}

docs/src/test/java/com/example/restassured/Hypermedia.java

@@ -0,0 +1,51 @@
+/*
+ * Copyright 2014-2021 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.
+ */
+
+package com.example.restassured;
+
+import io.restassured.RestAssured;
+import io.restassured.specification.RequestSpecification;
+
+import static org.hamcrest.CoreMatchers.is;
+import static org.springframework.restdocs.hypermedia.HypermediaDocumentation.halLinks;
+import static org.springframework.restdocs.hypermedia.HypermediaDocumentation.linkWithRel;
+import static org.springframework.restdocs.hypermedia.HypermediaDocumentation.links;
+import static org.springframework.restdocs.restassured.RestAssuredRestDocumentation.document;
+
+public class Hypermedia {
+
+	private RequestSpecification spec;
+
+	public void defaultExtractor() throws Exception {
+		// tag::links[]
+		RestAssured.given(this.spec).accept("application/json").filter(document("index", links(// <1>
+				linkWithRel("alpha").description("Link to the alpha resource"), // <2>
+				linkWithRel("bravo").description("Link to the bravo resource")))) // <3>
+				.get("/").then().assertThat().statusCode(is(200));
+		// end::links[]
+	}
+
+	public void explicitExtractor() throws Exception {
+		RestAssured.given(this.spec).accept("application/json")
+				// tag::explicit-extractor[]
+				.filter(document("index", links(halLinks(), // <1>
+						linkWithRel("alpha").description("Link to the alpha resource"),
+						linkWithRel("bravo").description("Link to the bravo resource"))))
+				// end::explicit-extractor[]
+				.get("/").then().assertThat().statusCode(is(200));
+	}
+
+}

docs/src/test/java/com/example/restassured/InvokeService.java

@@ -0,0 +1,39 @@
+/*
+ * Copyright 2014-2021 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.
+ */
+
+package com.example.restassured;
+
+import io.restassured.RestAssured;
+import io.restassured.specification.RequestSpecification;
+
+import static org.hamcrest.CoreMatchers.is;
+import static org.springframework.restdocs.restassured.RestAssuredRestDocumentation.document;
+
+public class InvokeService {
+
+	private RequestSpecification spec;
+
+	public void invokeService() throws Exception {
+		// tag::invoke-service[]
+		RestAssured.given(this.spec) // <1>
+				.accept("application/json") // <2>
+				.filter(document("index")) // <3>
+				.when().get("/") // <4>
+				.then().assertThat().statusCode(is(200)); // <5>
+		// end::invoke-service[]
+	}
+
+}

docs/src/test/java/com/example/restassured/ParameterizedOutput.java

@@ -0,0 +1,45 @@
+/*
+ * Copyright 2014-2021 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.
+ */
+
+package com.example.restassured;
+
+import io.restassured.builder.RequestSpecBuilder;
+import io.restassured.specification.RequestSpecification;
+import org.junit.Before;
+import org.junit.Rule;
+
+import org.springframework.restdocs.JUnitRestDocumentation;
+
+import static org.springframework.restdocs.restassured.RestAssuredRestDocumentation.document;
+import static org.springframework.restdocs.restassured.RestAssuredRestDocumentation.documentationConfiguration;
+
+public class ParameterizedOutput {
+
+	@Rule
+	public final JUnitRestDocumentation restDocumentation = new JUnitRestDocumentation();
+
+	@SuppressWarnings("unused")
+	private RequestSpecification spec;
+
+	// tag::parameterized-output[]
+	@Before
+	public void setUp() {
+		this.spec = new RequestSpecBuilder().addFilter(documentationConfiguration(this.restDocumentation))
+				.addFilter(document("{method-name}/{step}")).build();
+	}
+	// end::parameterized-output[]
+
+}

docs/src/test/java/com/example/restassured/PathParameters.java

@@ -0,0 +1,41 @@
+/*
+ * Copyright 2014-2021 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.
+ */
+
+package com.example.restassured;
+
+import io.restassured.RestAssured;
+import io.restassured.specification.RequestSpecification;
+
+import static org.hamcrest.CoreMatchers.is;
+import static org.springframework.restdocs.request.RequestDocumentation.parameterWithName;
+import static org.springframework.restdocs.request.RequestDocumentation.pathParameters;
+import static org.springframework.restdocs.restassured.RestAssuredRestDocumentation.document;
+
+public class PathParameters {
+
+	private RequestSpecification spec;
+
+	public void pathParametersSnippet() throws Exception {
+		// tag::path-parameters[]
+		RestAssured.given(this.spec).filter(document("locations", pathParameters(// <1>
+				parameterWithName("latitude").description("The location's latitude"), // <2>
+				parameterWithName("longitude").description("The location's longitude")))) // <3>
+				.when().get("/locations/{latitude}/{longitude}", 51.5072, 0.1275) // <4>
+				.then().assertThat().statusCode(is(200));
+		// end::path-parameters[]
+	}
+
+}

docs/src/test/java/com/example/restassured/Payload.java

@@ -0,0 +1,115 @@
+/*
+ * Copyright 2014-2021 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.
+ */
+
+package com.example.restassured;
+
+import io.restassured.RestAssured;
+import io.restassured.specification.RequestSpecification;
+
+import org.springframework.restdocs.payload.FieldDescriptor;
+import org.springframework.restdocs.payload.JsonFieldType;
+
+import static org.hamcrest.CoreMatchers.is;
+import static org.springframework.restdocs.payload.PayloadDocumentation.beneathPath;
+import static org.springframework.restdocs.payload.PayloadDocumentation.fieldWithPath;
+import static org.springframework.restdocs.payload.PayloadDocumentation.requestFields;
+import static org.springframework.restdocs.payload.PayloadDocumentation.responseBody;
+import static org.springframework.restdocs.payload.PayloadDocumentation.responseFields;
+import static org.springframework.restdocs.payload.PayloadDocumentation.subsectionWithPath;
+import static org.springframework.restdocs.restassured.RestAssuredRestDocumentation.document;
+import static org.springframework.restdocs.snippet.Attributes.attributes;
+import static org.springframework.restdocs.snippet.Attributes.key;
+
+public class Payload {
+
+	private RequestSpecification spec;
+
+	public void response() throws Exception {
+		// tag::response[]
+		RestAssured.given(this.spec).accept("application/json").filter(document("user", responseFields(// <1>
+				fieldWithPath("contact.name").description("The user's name"), // <2>
+				fieldWithPath("contact.email").description("The user's email address")))) // <3>
+				.when().get("/user/5").then().assertThat().statusCode(is(200));
+		// end::response[]
+	}
+
+	public void subsection() throws Exception {
+		// tag::subsection[]
+		RestAssured.given(this.spec).accept("application/json")
+				.filter(document("user",
+						responseFields(subsectionWithPath("contact").description("The user's contact details")))) // <1>
+				.when().get("/user/5").then().assertThat().statusCode(is(200));
+		// end::subsection[]
+	}
+
+	public void explicitType() throws Exception {
+		RestAssured.given(this.spec).accept("application/json")
+				// tag::explicit-type[]
+				.filter(document("user", responseFields(fieldWithPath("contact.email").type(JsonFieldType.STRING) // <1>
+						.description("The user's email address"))))
+				// end::explicit-type[]
+				.when().get("/user/5").then().assertThat().statusCode(is(200));
+	}
+
+	public void constraints() throws Exception {
+		RestAssured.given(this.spec).accept("application/json")
+				// tag::constraints[]
+				.filter(document("create-user",
+						requestFields(attributes(key("title").value("Fields for user creation")), // <1>
+								fieldWithPath("name").description("The user's name")
+										.attributes(key("constraints").value("Must not be null. Must not be empty")), // <2>
+								fieldWithPath("email").description("The user's email address")
+										.attributes(key("constraints").value("Must be a valid email address"))))) // <3>
+				// end::constraints[]
+				.when().post("/users").then().assertThat().statusCode(is(200));
+	}
+
+	public void descriptorReuse() throws Exception {
+		FieldDescriptor[] book = new FieldDescriptor[] { fieldWithPath("title").description("Title of the book"),
+				fieldWithPath("author").description("Author of the book") };
+
+		// tag::single-book[]
+		RestAssured.given(this.spec).accept("application/json").filter(document("book", responseFields(book))) // <1>
+				.when().get("/books/1").then().assertThat().statusCode(is(200));
+		// end::single-book[]
+
+		// tag::book-array[]
+		RestAssured.given(this.spec).accept("application/json")
+				.filter(document("books", responseFields(fieldWithPath("[]").description("An array of books")) // <1>
+						.andWithPrefix("[].", book))) // <2>
+				.when().get("/books").then().assertThat().statusCode(is(200));
+		// end::book-array[]
+	}
+
+	public void fieldsSubsection() throws Exception {
+		// tag::fields-subsection[]
+		RestAssured.given(this.spec).accept("application/json")
+				.filter(document("location", responseFields(beneathPath("weather.temperature"), // <1>
+						fieldWithPath("high").description("The forecast high in degrees celcius"), // <2>
+						fieldWithPath("low").description("The forecast low in degrees celcius"))))
+				.when().get("/locations/1").then().assertThat().statusCode(is(200));
+		// end::fields-subsection[]
+	}
+
+	public void bodySubsection() throws Exception {
+		// tag::body-subsection[]
+		RestAssured.given(this.spec).accept("application/json")
+				.filter(document("location", responseBody(beneathPath("weather.temperature")))) // <1>
+				.when().get("/locations/1").then().assertThat().statusCode(is(200));
+		// end::body-subsection[]
+	}
+
+}

docs/src/test/java/com/example/restassured/PerTestPreprocessing.java

@@ -0,0 +1,41 @@
+/*
+ * Copyright 2014-2021 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.
+ */
+
+package com.example.restassured;
+
+import io.restassured.RestAssured;
+import io.restassured.specification.RequestSpecification;
+
+import static org.hamcrest.CoreMatchers.is;
+import static org.springframework.restdocs.operation.preprocess.Preprocessors.preprocessRequest;
+import static org.springframework.restdocs.operation.preprocess.Preprocessors.preprocessResponse;
+import static org.springframework.restdocs.operation.preprocess.Preprocessors.prettyPrint;
+import static org.springframework.restdocs.operation.preprocess.Preprocessors.removeHeaders;
+import static org.springframework.restdocs.restassured.RestAssuredRestDocumentation.document;
+
+public class PerTestPreprocessing {
+
+	private RequestSpecification spec;
+
+	public void general() throws Exception {
+		// tag::preprocessing[]
+		RestAssured.given(this.spec).filter(document("index", preprocessRequest(removeHeaders("Foo")), // <1>
+				preprocessResponse(prettyPrint()))) // <2>
+				.when().get("/").then().assertThat().statusCode(is(200));
+		// end::preprocessing[]
+	}
+
+}

docs/src/test/java/com/example/restassured/RequestParameters.java

@@ -0,0 +1,52 @@
+/*
+ * Copyright 2014-2021 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.
+ */
+
+package com.example.restassured;
+
+import io.restassured.RestAssured;
+import io.restassured.specification.RequestSpecification;
+
+import static org.hamcrest.CoreMatchers.is;
+import static org.springframework.restdocs.request.RequestDocumentation.parameterWithName;
+import static org.springframework.restdocs.request.RequestDocumentation.requestParameters;
+import static org.springframework.restdocs.restassured.RestAssuredRestDocumentation.document;
+
+public class RequestParameters {
+
+	private RequestSpecification spec;
+
+	public void getQueryStringSnippet() throws Exception {
+		// tag::request-parameters-query-string[]
+		RestAssured.given(this.spec).filter(document("users", requestParameters(// <1>
+				parameterWithName("page").description("The page to retrieve"), // <2>
+				parameterWithName("per_page").description("Entries per page")))) // <3>
+				.when().get("/users?page=2&per_page=100") // <4>
+				.then().assertThat().statusCode(is(200));
+		// end::request-parameters-query-string[]
+	}
+
+	public void postFormDataSnippet() throws Exception {
+		// tag::request-parameters-form-data[]
+		RestAssured.given(this.spec)
+				.filter(document("create-user",
+						requestParameters(parameterWithName("username").description("The user's username"))))
+				.formParam("username", "Tester") // <1>
+				.when().post("/users") // <2>
+				.then().assertThat().statusCode(is(200));
+		// end::request-parameters-form-data[]
+	}
+
+}

docs/src/test/java/com/example/restassured/RequestPartPayload.java

@@ -0,0 +1,59 @@
+/*
+ * Copyright 2014-2021 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.
+ */
+
+package com.example.restassured;
+
+import java.io.File;
+import java.util.HashMap;
+import java.util.Map;
+
+import io.restassured.RestAssured;
+import io.restassured.specification.RequestSpecification;
+
+import static org.hamcrest.CoreMatchers.is;
+import static org.springframework.restdocs.payload.PayloadDocumentation.fieldWithPath;
+import static org.springframework.restdocs.payload.PayloadDocumentation.requestPartBody;
+import static org.springframework.restdocs.payload.PayloadDocumentation.requestPartFields;
+import static org.springframework.restdocs.restassured.RestAssuredRestDocumentation.document;
+
+public class RequestPartPayload {
+
+	private RequestSpecification spec;
+
+	public void fields() throws Exception {
+		// tag::fields[]
+		Map<String, String> metadata = new HashMap<>();
+		metadata.put("version", "1.0");
+		RestAssured.given(this.spec).accept("application/json")
+				.filter(document("image-upload", requestPartFields("metadata", // <1>
+						fieldWithPath("version").description("The version of the image")))) // <2>
+				.when().multiPart("image", new File("image.png"), "image/png").multiPart("metadata", metadata)
+				.post("images").then().assertThat().statusCode(is(200));
+		// end::fields[]
+	}
+
+	public void body() throws Exception {
+		// tag::body[]
+		Map<String, String> metadata = new HashMap<>();
+		metadata.put("version", "1.0");
+		RestAssured.given(this.spec).accept("application/json")
+				.filter(document("image-upload", requestPartBody("metadata"))) // <1>
+				.when().multiPart("image", new File("image.png"), "image/png").multiPart("metadata", metadata)
+				.post("images").then().assertThat().statusCode(is(200));
+		// end::body[]
+	}
+
+}

docs/src/test/java/com/example/restassured/RequestParts.java

@@ -0,0 +1,41 @@
+/*
+ * Copyright 2014-2021 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.
+ */
+
+package com.example.restassured;
+
+import io.restassured.RestAssured;
+import io.restassured.specification.RequestSpecification;
+
+import static org.hamcrest.CoreMatchers.is;
+import static org.springframework.restdocs.request.RequestDocumentation.partWithName;
+import static org.springframework.restdocs.request.RequestDocumentation.requestParts;
+import static org.springframework.restdocs.restassured.RestAssuredRestDocumentation.document;
+
+public class RequestParts {
+
+	private RequestSpecification spec;
+
+	public void upload() throws Exception {
+		// tag::request-parts[]
+		RestAssured.given(this.spec).filter(document("users", requestParts(// <1>
+				partWithName("file").description("The file to upload")))) // <2>
+				.multiPart("file", "example") // <3>
+				.when().post("/upload") // <4>
+				.then().statusCode(is(200));
+		// end::request-parts[]
+	}
+
+}

docs/src/test/java/com/example/restassured/RestAssuredSnippetReuse.java

@@ -0,0 +1,40 @@
+/*
+ * Copyright 2014-2021 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.
+ */
+
+package com.example.restassured;
+
+import com.example.SnippetReuse;
+import io.restassured.RestAssured;
+import io.restassured.specification.RequestSpecification;
+
+import static org.hamcrest.CoreMatchers.is;
+import static org.springframework.restdocs.hypermedia.HypermediaDocumentation.linkWithRel;
+import static org.springframework.restdocs.restassured.RestAssuredRestDocumentation.document;
+
+public class RestAssuredSnippetReuse extends SnippetReuse {
+
+	private RequestSpecification spec;
+
+	public void documentation() throws Exception {
+		// tag::use[]
+		RestAssured.given(this.spec).accept("application/json").filter(document("example", this.pagingLinks.and(// <1>
+				linkWithRel("alpha").description("Link to the alpha resource"),
+				linkWithRel("bravo").description("Link to the bravo resource")))).get("/").then().assertThat()
+				.statusCode(is(200));
+		// end::use[]
+	}
+
+}