0c8a71370b
This commit updates the API to improve its extensibility and
readability.
SnippetWritingResultHandler has been replaced with a more general
purpose Snippet interface. Snippets are now provided to the main
document method using varargs rather than the various with… methods
that were previously used. As a result a custom Snippet implementation
can now be used in exactly the same way as any of the built-in
snippets:
this.mockMvc.perform(get("/"))
.andExpect(status().isOk())
.andDo(document("index-example",
links(
linkWithRel("notes").description("…"),
linkWithRel("tags").description("…")),
responseFields(
fieldWithPath("_links").description("…")),
yourCustomSnippet()));
Control of the snippets that are generated by default is now available
via RestDocumentationConfigurer:
this.mockMvc = MockMvcBuilders.webAppContextSetup(this.context)
.apply(documentationConfiguration().snippets()
.withDefaults(curlRequest(), yourCustomSnippet()))
.build();
See gh-73
43 lines
1.6 KiB
Java
43 lines
1.6 KiB
Java
/*
|
|
* Copyright 2014-2015 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;
|
|
|
|
import static org.springframework.restdocs.RestDocumentation.document;
|
|
import static org.springframework.restdocs.request.RequestDocumentation.parameterWithName;
|
|
import static org.springframework.restdocs.request.RequestDocumentation.queryParameters;
|
|
import static org.springframework.restdocs.RestDocumentationRequestBuilders.get;
|
|
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;
|
|
|
|
import org.springframework.test.web.servlet.MockMvc;
|
|
|
|
public class QueryParameters {
|
|
|
|
private MockMvc mockMvc;
|
|
|
|
public void queryParametersSnippet() throws Exception {
|
|
// tag::query-parameters[]
|
|
this.mockMvc.perform(get("/users?page=2&per_page=100"))
|
|
.andExpect(status().isOk())
|
|
.andDo(document("users", queryParameters( // <1>
|
|
parameterWithName("page").description("The page to retrieve"), // <2>
|
|
parameterWithName("per_page").description("Entries per page") // <3>
|
|
)));
|
|
// end::query-parameters[]
|
|
}
|
|
|
|
}
|