130b411e2a
This commit adds a new module, spring-restdocs-restassured, that can be used to generate documentation snippets when testing a service with REST Assured. Please refer to the updated reference documentation for details. Thanks to Johan Haleby for making a change to REST Assured so that path parameters could be documented. Closes gh-102
42 lines
1.7 KiB
Java
42 lines
1.7 KiB
Java
/*
|
|
* Copyright 2014-2016 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
|
|
*
|
|
* http://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.mockmvc;
|
|
|
|
import org.springframework.test.web.servlet.MockMvc;
|
|
|
|
import static org.springframework.restdocs.mockmvc.MockMvcRestDocumentation.document;
|
|
import static org.springframework.restdocs.mockmvc.RestDocumentationRequestBuilders.get;
|
|
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.test.web.servlet.result.MockMvcResultMatchers.status;
|
|
|
|
public class PerTestPreprocessing {
|
|
|
|
private MockMvc mockMvc;
|
|
|
|
public void general() throws Exception {
|
|
// tag::preprocessing[]
|
|
this.mockMvc.perform(get("/")).andExpect(status().isOk())
|
|
.andDo(document("index", preprocessRequest(removeHeaders("Foo")), // <1>
|
|
preprocessResponse(prettyPrint()))); // <2>
|
|
// end::preprocessing[]
|
|
}
|
|
|
|
}
|