Spring/spring-restdocs
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add support for modifying a request prior to it being documented

Browse Source 
Prior to this commit it was not possible to modify a request prior to
it being documented, only a response. This commit builds on the new
Operation abstraction to simplify the existing response modification
support and to add support for request modification.

Closes gh-84
This commit is contained in:
Andy Wilkinson
2015-09-02 12:40:59 +01:00
parent 3579b34a77
commit 9d8bbf0558
34 changed files with 992 additions and 885 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
docs/src/test/java/com/example/ResponsePostProcessing.java → docs/src/test/java/com/example/Preprocessing.java
View File

@@ -16,13 +16,17 @@
package com.example;
import static org.springframework.restdocs.RestDocumentation.modifyResponseTo;
import static org.springframework.restdocs.RestDocumentationRequestBuilders.get;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;
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.removeHeaders;
import static org.springframework.restdocs.operation.preprocess.Preprocessors.prettyPrint;
import static org.springframework.restdocs.RestDocumentation.document;
import org.springframework.test.web.servlet.MockMvc;
public class ResponsePostProcessing {
public class Preprocessing {
private MockMvc mockMvc;
@@ -30,8 +34,9 @@ public class ResponsePostProcessing {
// tag::general[]
this.mockMvc.perform(get("/"))
.andExpect(status().isOk())
.andDo(modifyResponseTo(/* ... */) // <1>
.andDocument("index")); // <2>
.andDo(document("index",
preprocessRequest(removeHeaders("Foo")), // <1>
preprocessResponse(prettyPrint()))); // <2>
// end::general[]
}