mirror of
https://github.com/spring-projects/spring-boot.git
synced 2024-08-29 03:06:45 +08:00
Upgrade to Spring REST Docs 1.0.0.RC1
This commit is contained in:
parent
f7a1db8e25
commit
b31e578489
@ -50,7 +50,7 @@
|
|||||||
</dependency>
|
</dependency>
|
||||||
<dependency>
|
<dependency>
|
||||||
<groupId>org.springframework.restdocs</groupId>
|
<groupId>org.springframework.restdocs</groupId>
|
||||||
<artifactId>spring-restdocs</artifactId>
|
<artifactId>spring-restdocs-mockmvc</artifactId>
|
||||||
<scope>provided</scope>
|
<scope>provided</scope>
|
||||||
</dependency>
|
</dependency>
|
||||||
</dependencies>
|
</dependencies>
|
||||||
@ -96,9 +96,6 @@
|
|||||||
<includes>
|
<includes>
|
||||||
<include>**/*Documentation.java</include>
|
<include>**/*Documentation.java</include>
|
||||||
</includes>
|
</includes>
|
||||||
<systemPropertyVariables>
|
|
||||||
<org.springframework.restdocs.outputDir>${project.build.directory}/generated-snippets</org.springframework.restdocs.outputDir>
|
|
||||||
</systemPropertyVariables>
|
|
||||||
<skipTests>false</skipTests>
|
<skipTests>false</skipTests>
|
||||||
</configuration>
|
</configuration>
|
||||||
<executions>
|
<executions>
|
||||||
|
@ -32,15 +32,16 @@ import java.util.Map;
|
|||||||
import javax.servlet.Filter;
|
import javax.servlet.Filter;
|
||||||
|
|
||||||
import org.junit.Before;
|
import org.junit.Before;
|
||||||
|
import org.junit.Rule;
|
||||||
import org.junit.Test;
|
import org.junit.Test;
|
||||||
import org.junit.runner.RunWith;
|
import org.junit.runner.RunWith;
|
||||||
import org.springframework.beans.factory.annotation.Autowired;
|
import org.springframework.beans.factory.annotation.Autowired;
|
||||||
import org.springframework.beans.factory.annotation.Qualifier;
|
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.MvcEndpoint;
|
||||||
import org.springframework.boot.actuate.endpoint.mvc.MvcEndpoints;
|
import org.springframework.boot.actuate.endpoint.mvc.MvcEndpoints;
|
||||||
import org.springframework.boot.test.SpringApplicationConfiguration;
|
import org.springframework.boot.test.SpringApplicationConfiguration;
|
||||||
import org.springframework.http.MediaType;
|
import org.springframework.http.MediaType;
|
||||||
|
import org.springframework.restdocs.RestDocumentation;
|
||||||
import org.springframework.test.annotation.DirtiesContext;
|
import org.springframework.test.annotation.DirtiesContext;
|
||||||
import org.springframework.test.context.TestPropertySource;
|
import org.springframework.test.context.TestPropertySource;
|
||||||
import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;
|
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.util.StringUtils;
|
||||||
import org.springframework.web.context.WebApplicationContext;
|
import org.springframework.web.context.WebApplicationContext;
|
||||||
|
|
||||||
import static org.springframework.restdocs.RestDocumentation.document;
|
import static org.springframework.restdocs.mockmvc.MockMvcRestDocumentation.document;
|
||||||
import static org.springframework.restdocs.RestDocumentation.documentationConfiguration;
|
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.request.MockMvcRequestBuilders.get;
|
||||||
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;
|
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;
|
||||||
|
|
||||||
@ -65,6 +66,12 @@ import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.
|
|||||||
@DirtiesContext
|
@DirtiesContext
|
||||||
public class EndpointDocumentation {
|
public class EndpointDocumentation {
|
||||||
|
|
||||||
|
private static final String RESTDOCS_OUTPUT_DIR = "target/generated-snippets";
|
||||||
|
|
||||||
|
@Rule
|
||||||
|
public final RestDocumentation restDocumentation = new RestDocumentation(
|
||||||
|
RESTDOCS_OUTPUT_DIR);
|
||||||
|
|
||||||
@Autowired
|
@Autowired
|
||||||
private WebApplicationContext context;
|
private WebApplicationContext context;
|
||||||
|
|
||||||
@ -82,18 +89,13 @@ public class EndpointDocumentation {
|
|||||||
@Autowired
|
@Autowired
|
||||||
private TemplateEngine templates;
|
private TemplateEngine templates;
|
||||||
|
|
||||||
@Value("${org.springframework.restdocs.outputDir:${user.dir}/target/generated-snippets}")
|
|
||||||
private String restdocsOutputDir;
|
|
||||||
|
|
||||||
private MockMvc mockMvc;
|
private MockMvc mockMvc;
|
||||||
|
|
||||||
@Before
|
@Before
|
||||||
public void setUp() {
|
public void setUp() {
|
||||||
System.setProperty("org.springframework.restdocs.outputDir",
|
|
||||||
this.restdocsOutputDir);
|
|
||||||
this.mockMvc = MockMvcBuilders.webAppContextSetup(this.context)
|
this.mockMvc = MockMvcBuilders.webAppContextSetup(this.context)
|
||||||
.addFilters(this.metricFilter, this.traceFilter)
|
.addFilters(this.metricFilter, this.traceFilter)
|
||||||
.apply(documentationConfiguration()).build();
|
.apply(documentationConfiguration(this.restDocumentation)).build();
|
||||||
}
|
}
|
||||||
|
|
||||||
@Test
|
@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();
|
file.getParentFile().mkdirs();
|
||||||
PrintWriter writer = new PrintWriter(file, "UTF-8");
|
PrintWriter writer = new PrintWriter(file, "UTF-8");
|
||||||
try {
|
try {
|
||||||
|
@ -17,12 +17,13 @@
|
|||||||
package org.springframework.boot.actuate.hypermedia;
|
package org.springframework.boot.actuate.hypermedia;
|
||||||
|
|
||||||
import org.junit.Before;
|
import org.junit.Before;
|
||||||
|
import org.junit.Rule;
|
||||||
import org.junit.Test;
|
import org.junit.Test;
|
||||||
import org.junit.runner.RunWith;
|
import org.junit.runner.RunWith;
|
||||||
import org.springframework.beans.factory.annotation.Autowired;
|
import org.springframework.beans.factory.annotation.Autowired;
|
||||||
import org.springframework.beans.factory.annotation.Value;
|
|
||||||
import org.springframework.boot.test.SpringApplicationConfiguration;
|
import org.springframework.boot.test.SpringApplicationConfiguration;
|
||||||
import org.springframework.http.MediaType;
|
import org.springframework.http.MediaType;
|
||||||
|
import org.springframework.restdocs.RestDocumentation;
|
||||||
import org.springframework.test.annotation.DirtiesContext;
|
import org.springframework.test.annotation.DirtiesContext;
|
||||||
import org.springframework.test.context.TestPropertySource;
|
import org.springframework.test.context.TestPropertySource;
|
||||||
import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;
|
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.test.web.servlet.setup.MockMvcBuilders;
|
||||||
import org.springframework.web.context.WebApplicationContext;
|
import org.springframework.web.context.WebApplicationContext;
|
||||||
|
|
||||||
import static org.springframework.restdocs.RestDocumentation.document;
|
import static org.springframework.restdocs.mockmvc.MockMvcRestDocumentation.document;
|
||||||
import static org.springframework.restdocs.RestDocumentation.documentationConfiguration;
|
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.request.MockMvcRequestBuilders.get;
|
||||||
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;
|
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;
|
||||||
|
|
||||||
@ -44,20 +45,19 @@ import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.
|
|||||||
@DirtiesContext
|
@DirtiesContext
|
||||||
public class HealthEndpointDocumentation {
|
public class HealthEndpointDocumentation {
|
||||||
|
|
||||||
|
@Rule
|
||||||
|
public final RestDocumentation restDocumentation = new RestDocumentation(
|
||||||
|
"target/generated-snippets");
|
||||||
|
|
||||||
@Autowired
|
@Autowired
|
||||||
private WebApplicationContext context;
|
private WebApplicationContext context;
|
||||||
|
|
||||||
@Value("${org.springframework.restdocs.outputDir:target/generated-snippets}")
|
|
||||||
private String restdocsOutputDir;
|
|
||||||
|
|
||||||
private MockMvc mockMvc;
|
private MockMvc mockMvc;
|
||||||
|
|
||||||
@Before
|
@Before
|
||||||
public void setUp() {
|
public void setUp() {
|
||||||
System.setProperty("org.springframework.restdocs.outputDir",
|
|
||||||
this.restdocsOutputDir);
|
|
||||||
this.mockMvc = MockMvcBuilders.webAppContextSetup(this.context)
|
this.mockMvc = MockMvcBuilders.webAppContextSetup(this.context)
|
||||||
.apply(documentationConfiguration()).build();
|
.apply(documentationConfiguration(this.restDocumentation)).build();
|
||||||
}
|
}
|
||||||
|
|
||||||
@Test
|
@Test
|
||||||
|
@ -17,12 +17,13 @@
|
|||||||
package org.springframework.boot.actuate.hypermedia;
|
package org.springframework.boot.actuate.hypermedia;
|
||||||
|
|
||||||
import org.junit.Before;
|
import org.junit.Before;
|
||||||
|
import org.junit.Rule;
|
||||||
import org.junit.Test;
|
import org.junit.Test;
|
||||||
import org.junit.runner.RunWith;
|
import org.junit.runner.RunWith;
|
||||||
import org.springframework.beans.factory.annotation.Autowired;
|
import org.springframework.beans.factory.annotation.Autowired;
|
||||||
import org.springframework.beans.factory.annotation.Value;
|
|
||||||
import org.springframework.boot.test.SpringApplicationConfiguration;
|
import org.springframework.boot.test.SpringApplicationConfiguration;
|
||||||
import org.springframework.http.MediaType;
|
import org.springframework.http.MediaType;
|
||||||
|
import org.springframework.restdocs.RestDocumentation;
|
||||||
import org.springframework.test.annotation.DirtiesContext;
|
import org.springframework.test.annotation.DirtiesContext;
|
||||||
import org.springframework.test.context.TestPropertySource;
|
import org.springframework.test.context.TestPropertySource;
|
||||||
import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;
|
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.test.web.servlet.setup.MockMvcBuilders;
|
||||||
import org.springframework.web.context.WebApplicationContext;
|
import org.springframework.web.context.WebApplicationContext;
|
||||||
|
|
||||||
import static org.springframework.restdocs.RestDocumentation.document;
|
import static org.springframework.restdocs.mockmvc.MockMvcRestDocumentation.document;
|
||||||
import static org.springframework.restdocs.RestDocumentation.documentationConfiguration;
|
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.request.MockMvcRequestBuilders.get;
|
||||||
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;
|
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;
|
||||||
|
|
||||||
@ -43,20 +44,19 @@ import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.
|
|||||||
@DirtiesContext
|
@DirtiesContext
|
||||||
public class HypermediaEndpointDocumentation {
|
public class HypermediaEndpointDocumentation {
|
||||||
|
|
||||||
|
@Rule
|
||||||
|
public final RestDocumentation restDocumentation = new RestDocumentation(
|
||||||
|
"target/generated-snippets");
|
||||||
|
|
||||||
@Autowired
|
@Autowired
|
||||||
private WebApplicationContext context;
|
private WebApplicationContext context;
|
||||||
|
|
||||||
@Value("${org.springframework.restdocs.outputDir:target/generated-snippets}")
|
|
||||||
private String restdocsOutputDir;
|
|
||||||
|
|
||||||
private MockMvc mockMvc;
|
private MockMvc mockMvc;
|
||||||
|
|
||||||
@Before
|
@Before
|
||||||
public void setUp() {
|
public void setUp() {
|
||||||
System.setProperty("org.springframework.restdocs.outputDir",
|
|
||||||
this.restdocsOutputDir);
|
|
||||||
this.mockMvc = MockMvcBuilders.webAppContextSetup(this.context)
|
this.mockMvc = MockMvcBuilders.webAppContextSetup(this.context)
|
||||||
.apply(documentationConfiguration()).build();
|
.apply(documentationConfiguration(this.restDocumentation)).build();
|
||||||
}
|
}
|
||||||
|
|
||||||
@Test
|
@Test
|
||||||
|
@ -23,7 +23,7 @@
|
|||||||
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
|
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
|
||||||
<project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
|
<project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
|
||||||
<maven.version>3.1.1</maven.version>
|
<maven.version>3.1.1</maven.version>
|
||||||
<spring-restdocs.version>1.0.0.M1</spring-restdocs.version>
|
<spring-restdocs.version>1.0.0.RC1</spring-restdocs.version>
|
||||||
</properties>
|
</properties>
|
||||||
<scm>
|
<scm>
|
||||||
<url>http://github.com/spring-projects/spring-boot</url>
|
<url>http://github.com/spring-projects/spring-boot</url>
|
||||||
@ -199,7 +199,7 @@
|
|||||||
</dependency>
|
</dependency>
|
||||||
<dependency>
|
<dependency>
|
||||||
<groupId>org.springframework.restdocs</groupId>
|
<groupId>org.springframework.restdocs</groupId>
|
||||||
<artifactId>spring-restdocs</artifactId>
|
<artifactId>spring-restdocs-mockmvc</artifactId>
|
||||||
<version>${spring-restdocs.version}</version>
|
<version>${spring-restdocs.version}</version>
|
||||||
</dependency>
|
</dependency>
|
||||||
<dependency>
|
<dependency>
|
||||||
|
Loading…
Reference in New Issue
Block a user