Upgrade to Spring REST Docs 1.0.0.RC1

This commit is contained in:
Andy Wilkinson
2015-09-08 21:10:38 +01:00
parent f7a1db8e25
commit b31e578489
5 changed files with 33 additions and 34 deletions

View File

@@ -32,15 +32,16 @@ import java.util.Map;
import javax.servlet.Filter;
import org.junit.Before;
import org.junit.Rule;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Qualifier;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.boot.actuate.endpoint.mvc.MvcEndpoint;
import org.springframework.boot.actuate.endpoint.mvc.MvcEndpoints;
import org.springframework.boot.test.SpringApplicationConfiguration;
import org.springframework.http.MediaType;
import org.springframework.restdocs.RestDocumentation;
import org.springframework.test.annotation.DirtiesContext;
import org.springframework.test.context.TestPropertySource;
import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;
@@ -52,8 +53,8 @@ import org.springframework.test.web.servlet.setup.MockMvcBuilders;
import org.springframework.util.StringUtils;
import org.springframework.web.context.WebApplicationContext;
import static org.springframework.restdocs.RestDocumentation.document;
import static org.springframework.restdocs.RestDocumentation.documentationConfiguration;
import static org.springframework.restdocs.mockmvc.MockMvcRestDocumentation.document;
import static org.springframework.restdocs.mockmvc.MockMvcRestDocumentation.documentationConfiguration;
import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;
@@ -65,6 +66,12 @@ import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.
@DirtiesContext
public class EndpointDocumentation {
private static final String RESTDOCS_OUTPUT_DIR = "target/generated-snippets";
@Rule
public final RestDocumentation restDocumentation = new RestDocumentation(
RESTDOCS_OUTPUT_DIR);
@Autowired
private WebApplicationContext context;
@@ -82,18 +89,13 @@ public class EndpointDocumentation {
@Autowired
private TemplateEngine templates;
@Value("${org.springframework.restdocs.outputDir:${user.dir}/target/generated-snippets}")
private String restdocsOutputDir;
private MockMvc mockMvc;
@Before
public void setUp() {
System.setProperty("org.springframework.restdocs.outputDir",
this.restdocsOutputDir);
this.mockMvc = MockMvcBuilders.webAppContextSetup(this.context)
.addFilters(this.metricFilter, this.traceFilter)
.apply(documentationConfiguration()).build();
.apply(documentationConfiguration(this.restDocumentation)).build();
}
@Test
@@ -129,7 +131,7 @@ public class EndpointDocumentation {
});
}
}
File file = new File(this.restdocsOutputDir + "/endpoints.adoc");
File file = new File(RESTDOCS_OUTPUT_DIR + "/endpoints.adoc");
file.getParentFile().mkdirs();
PrintWriter writer = new PrintWriter(file, "UTF-8");
try {

View File

@@ -17,12 +17,13 @@
package org.springframework.boot.actuate.hypermedia;
import org.junit.Before;
import org.junit.Rule;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.boot.test.SpringApplicationConfiguration;
import org.springframework.http.MediaType;
import org.springframework.restdocs.RestDocumentation;
import org.springframework.test.annotation.DirtiesContext;
import org.springframework.test.context.TestPropertySource;
import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;
@@ -31,8 +32,8 @@ import org.springframework.test.web.servlet.MockMvc;
import org.springframework.test.web.servlet.setup.MockMvcBuilders;
import org.springframework.web.context.WebApplicationContext;
import static org.springframework.restdocs.RestDocumentation.document;
import static org.springframework.restdocs.RestDocumentation.documentationConfiguration;
import static org.springframework.restdocs.mockmvc.MockMvcRestDocumentation.document;
import static org.springframework.restdocs.mockmvc.MockMvcRestDocumentation.documentationConfiguration;
import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;
@@ -44,20 +45,19 @@ import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.
@DirtiesContext
public class HealthEndpointDocumentation {
@Rule
public final RestDocumentation restDocumentation = new RestDocumentation(
"target/generated-snippets");
@Autowired
private WebApplicationContext context;
@Value("${org.springframework.restdocs.outputDir:target/generated-snippets}")
private String restdocsOutputDir;
private MockMvc mockMvc;
@Before
public void setUp() {
System.setProperty("org.springframework.restdocs.outputDir",
this.restdocsOutputDir);
this.mockMvc = MockMvcBuilders.webAppContextSetup(this.context)
.apply(documentationConfiguration()).build();
.apply(documentationConfiguration(this.restDocumentation)).build();
}
@Test

View File

@@ -17,12 +17,13 @@
package org.springframework.boot.actuate.hypermedia;
import org.junit.Before;
import org.junit.Rule;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.boot.test.SpringApplicationConfiguration;
import org.springframework.http.MediaType;
import org.springframework.restdocs.RestDocumentation;
import org.springframework.test.annotation.DirtiesContext;
import org.springframework.test.context.TestPropertySource;
import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;
@@ -31,8 +32,8 @@ import org.springframework.test.web.servlet.MockMvc;
import org.springframework.test.web.servlet.setup.MockMvcBuilders;
import org.springframework.web.context.WebApplicationContext;
import static org.springframework.restdocs.RestDocumentation.document;
import static org.springframework.restdocs.RestDocumentation.documentationConfiguration;
import static org.springframework.restdocs.mockmvc.MockMvcRestDocumentation.document;
import static org.springframework.restdocs.mockmvc.MockMvcRestDocumentation.documentationConfiguration;
import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;
@@ -43,20 +44,19 @@ import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.
@DirtiesContext
public class HypermediaEndpointDocumentation {
@Rule
public final RestDocumentation restDocumentation = new RestDocumentation(
"target/generated-snippets");
@Autowired
private WebApplicationContext context;
@Value("${org.springframework.restdocs.outputDir:target/generated-snippets}")
private String restdocsOutputDir;
private MockMvc mockMvc;
@Before
public void setUp() {
System.setProperty("org.springframework.restdocs.outputDir",
this.restdocsOutputDir);
this.mockMvc = MockMvcBuilders.webAppContextSetup(this.context)
.apply(documentationConfiguration()).build();
.apply(documentationConfiguration(this.restDocumentation)).build();
}
@Test