2b2b6fcd25
This commit splits Spring REST Docs into two projects – spring-restdocs-core and spring-restdocs-mockmvc. spring-restdocs-core contains the vast majority of the code but does not depend on a specific test framework other than JUnit. The use of a Spring Test TestExecutionListener has been replaced with a JUnit test rule. The rule is declared once per test class and configured with the output directory to which the generated snippets should be written. This simplifies the implementation as thread local storage is no longer required to transfer information about the test that’s running into Spring REST Docs. Instead, this transfer is now handled by the new test rule. It has also simplified the configuration as it’s no longer necessary for users to provide a system property that configures the output directory. spring-restdocs-mockmvc contains code that’s specific to using Spring REST Docs with Spring MVC Test’s MockMvc. This is currently the only testing framework that’s supported, but it paves the way for adding support for additional frameworks. REST Assured is one that users seem particularly interested in (see gh-80 and gh-102). Closes gh-107
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.mockmvc.MockMvcRestDocumentation.document;
|
|
import static org.springframework.restdocs.mockmvc.RestDocumentationRequestBuilders.get;
|
|
import static org.springframework.restdocs.request.RequestDocumentation.parameterWithName;
|
|
import static org.springframework.restdocs.request.RequestDocumentation.pathParameters;
|
|
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;
|
|
|
|
import org.springframework.test.web.servlet.MockMvc;
|
|
|
|
public class PathParameters {
|
|
|
|
private MockMvc mockMvc;
|
|
|
|
public void pathParametersSnippet() throws Exception {
|
|
// tag::path-parameters[]
|
|
this.mockMvc.perform(get("/locations/{latitude}/{longitude}", 51.5072, 0.1275)) // <1>
|
|
.andExpect(status().isOk())
|
|
.andDo(document("locations", pathParameters( // <2>
|
|
parameterWithName("latitude").description("The location's latitude"), // <3>
|
|
parameterWithName("longitude").description("The location's longitude") // <4>
|
|
)));
|
|
// end::path-parameters[]
|
|
}
|
|
|
|
}
|