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

Update the README to reflect the changes to how document is used

Browse Source
This commit is contained in:
Andy Wilkinson
2014-12-02 12:20:08 +00:00
parent ff7119ec54
commit 23e8ad3dae
1 changed files with 5 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
README.md
View File

@@ -91,11 +91,14 @@ public void setUp() {
The default values are `http`, `localhost`, and `8080`. You can omit the above
configuration if these defaults meet your needs.
To document a MockMvc call, wrap it in a call to `RestDocumentation.document`:
To document a MockMvc call, you use MockMvc's `andDo` method, passing it a
`RestDocumentationResultHandler` that can be easily obtained from
the static `RestDocumentation.document` method:
```java
public void getIndex() {
document("index", this.mockMvc.perform(get("/").accept(MediaType.APPLICATION_JSON)));
this.mockMvc.perform(get("/").accept(MediaType.APPLICATION_JSON))
.andDo(document("index"));
}
```