Skip to content

Commit b31e578

Browse files
wilkinsonawilkinsona
committed
Upgrade to Spring REST Docs 1.0.0.RC1
1 parent f7a1db8 commit b31e578

File tree

5 files changed

+33
-34
lines changed

5 files changed

+33
-34
lines changed

‎spring-boot-actuator-docs/pom.xml‎

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@
5050
</dependency>
5151
<dependency>
5252
<groupId>org.springframework.restdocs</groupId>
53-
<artifactId>spring-restdocs</artifactId>
53+
<artifactId>spring-restdocs-mockmvc</artifactId>
5454
<scope>provided</scope>
5555
</dependency>
5656
</dependencies>
@@ -96,9 +96,6 @@
9696
<includes>
9797
<include>**/*Documentation.java</include>
9898
</includes>
99-
<systemPropertyVariables>
100-
<org.springframework.restdocs.outputDir>${project.build.directory}/generated-snippets</org.springframework.restdocs.outputDir>
101-
</systemPropertyVariables>
10299
<skipTests>false</skipTests>
103100
</configuration>
104101
<executions>

‎spring-boot-actuator-docs/src/restdoc/java/org/springframework/boot/actuate/hypermedia/EndpointDocumentation.java‎

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -32,15 +32,16 @@
3232
import javax.servlet.Filter;
3333

3434
import org.junit.Before;
35+
import org.junit.Rule;
3536
import org.junit.Test;
3637
import org.junit.runner.RunWith;
3738
import org.springframework.beans.factory.annotation.Autowired;
3839
import org.springframework.beans.factory.annotation.Qualifier;
39-
import org.springframework.beans.factory.annotation.Value;
4040
import org.springframework.boot.actuate.endpoint.mvc.MvcEndpoint;
4141
import org.springframework.boot.actuate.endpoint.mvc.MvcEndpoints;
4242
import org.springframework.boot.test.SpringApplicationConfiguration;
4343
import org.springframework.http.MediaType;
44+
import org.springframework.restdocs.RestDocumentation;
4445
import org.springframework.test.annotation.DirtiesContext;
4546
import org.springframework.test.context.TestPropertySource;
4647
import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;
@@ -52,8 +53,8 @@
5253
import org.springframework.util.StringUtils;
5354
import org.springframework.web.context.WebApplicationContext;
5455

55-
import static org.springframework.restdocs.RestDocumentation.document;
56-
import static org.springframework.restdocs.RestDocumentation.documentationConfiguration;
56+
import static org.springframework.restdocs.mockmvc.MockMvcRestDocumentation.document;
57+
import static org.springframework.restdocs.mockmvc.MockMvcRestDocumentation.documentationConfiguration;
5758
import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get;
5859
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;
5960

@@ -65,6 +66,12 @@
6566
@DirtiesContext
6667
public class EndpointDocumentation {
6768

69+
private static final String RESTDOCS_OUTPUT_DIR = "target/generated-snippets";
70+
71+
@Rule
72+
public final RestDocumentation restDocumentation = new RestDocumentation(
73+
RESTDOCS_OUTPUT_DIR);
74+
6875
@Autowired
6976
private WebApplicationContext context;
7077

@@ -82,18 +89,13 @@ public class EndpointDocumentation {
8289
@Autowired
8390
private TemplateEngine templates;
8491

85-
@Value("${org.springframework.restdocs.outputDir:${user.dir}/target/generated-snippets}")
86-
private String restdocsOutputDir;
87-
8892
private MockMvc mockMvc;
8993

9094
@Before
9195
public void setUp() {
92-
System.setProperty("org.springframework.restdocs.outputDir",
93-
this.restdocsOutputDir);
9496
this.mockMvc = MockMvcBuilders.webAppContextSetup(this.context)
9597
.addFilters(this.metricFilter, this.traceFilter)
96-
.apply(documentationConfiguration()).build();
98+
.apply(documentationConfiguration(this.restDocumentation)).build();
9799
}
98100

99101
@Test
@@ -129,7 +131,7 @@ public void handle(MvcResult mvcResult) throws Exception {
129131
});
130132
}
131133
}
132-
File file = new File(this.restdocsOutputDir + "/endpoints.adoc");
134+
File file = new File(RESTDOCS_OUTPUT_DIR + "/endpoints.adoc");
133135
file.getParentFile().mkdirs();
134136
PrintWriter writer = new PrintWriter(file, "UTF-8");
135137
try {

‎spring-boot-actuator-docs/src/restdoc/java/org/springframework/boot/actuate/hypermedia/HealthEndpointDocumentation.java‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -17,12 +17,13 @@
1717
package org.springframework.boot.actuate.hypermedia;
1818

1919
import org.junit.Before;
20+
import org.junit.Rule;
2021
import org.junit.Test;
2122
import org.junit.runner.RunWith;
2223
import org.springframework.beans.factory.annotation.Autowired;
23-
import org.springframework.beans.factory.annotation.Value;
2424
import org.springframework.boot.test.SpringApplicationConfiguration;
2525
import org.springframework.http.MediaType;
26+
import org.springframework.restdocs.RestDocumentation;
2627
import org.springframework.test.annotation.DirtiesContext;
2728
import org.springframework.test.context.TestPropertySource;
2829
import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;
@@ -31,8 +32,8 @@
3132
import org.springframework.test.web.servlet.setup.MockMvcBuilders;
3233
import org.springframework.web.context.WebApplicationContext;
3334

34-
import static org.springframework.restdocs.RestDocumentation.document;
35-
import static org.springframework.restdocs.RestDocumentation.documentationConfiguration;
35+
import static org.springframework.restdocs.mockmvc.MockMvcRestDocumentation.document;
36+
import static org.springframework.restdocs.mockmvc.MockMvcRestDocumentation.documentationConfiguration;
3637
import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get;
3738
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;
3839

@@ -44,20 +45,19 @@
4445
@DirtiesContext
4546
public class HealthEndpointDocumentation {
4647

48+
@Rule
49+
public final RestDocumentation restDocumentation = new RestDocumentation(
50+
"target/generated-snippets");
51+
4752
@Autowired
4853
private WebApplicationContext context;
4954

50-
@Value("${org.springframework.restdocs.outputDir:target/generated-snippets}")
51-
private String restdocsOutputDir;
52-
5355
private MockMvc mockMvc;
5456

5557
@Before
5658
public void setUp() {
57-
System.setProperty("org.springframework.restdocs.outputDir",
58-
this.restdocsOutputDir);
5959
this.mockMvc = MockMvcBuilders.webAppContextSetup(this.context)
60-
.apply(documentationConfiguration()).build();
60+
.apply(documentationConfiguration(this.restDocumentation)).build();
6161
}
6262

6363
@Test

‎spring-boot-actuator-docs/src/restdoc/java/org/springframework/boot/actuate/hypermedia/HypermediaEndpointDocumentation.java‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -17,12 +17,13 @@
1717
package org.springframework.boot.actuate.hypermedia;
1818

1919
import org.junit.Before;
20+
import org.junit.Rule;
2021
import org.junit.Test;
2122
import org.junit.runner.RunWith;
2223
import org.springframework.beans.factory.annotation.Autowired;
23-
import org.springframework.beans.factory.annotation.Value;
2424
import org.springframework.boot.test.SpringApplicationConfiguration;
2525
import org.springframework.http.MediaType;
26+
import org.springframework.restdocs.RestDocumentation;
2627
import org.springframework.test.annotation.DirtiesContext;
2728
import org.springframework.test.context.TestPropertySource;
2829
import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;
@@ -31,8 +32,8 @@
3132
import org.springframework.test.web.servlet.setup.MockMvcBuilders;
3233
import org.springframework.web.context.WebApplicationContext;
3334

34-
import static org.springframework.restdocs.RestDocumentation.document;
35-
import static org.springframework.restdocs.RestDocumentation.documentationConfiguration;
35+
import static org.springframework.restdocs.mockmvc.MockMvcRestDocumentation.document;
36+
import static org.springframework.restdocs.mockmvc.MockMvcRestDocumentation.documentationConfiguration;
3637
import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get;
3738
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;
3839

@@ -43,20 +44,19 @@
4344
@DirtiesContext
4445
public class HypermediaEndpointDocumentation {
4546

47+
@Rule
48+
public final RestDocumentation restDocumentation = new RestDocumentation(
49+
"target/generated-snippets");
50+
4651
@Autowired
4752
private WebApplicationContext context;
4853

49-
@Value("${org.springframework.restdocs.outputDir:target/generated-snippets}")
50-
private String restdocsOutputDir;
51-
5254
private MockMvc mockMvc;
5355

5456
@Before
5557
public void setUp() {
56-
System.setProperty("org.springframework.restdocs.outputDir",
57-
this.restdocsOutputDir);
5858
this.mockMvc = MockMvcBuilders.webAppContextSetup(this.context)
59-
.apply(documentationConfiguration()).build();
59+
.apply(documentationConfiguration(this.restDocumentation)).build();
6060
}
6161

6262
@Test

‎spring-boot-parent/pom.xml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
2424
<project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
2525
<maven.version>3.1.1</maven.version>
26-
<spring-restdocs.version>1.0.0.M1</spring-restdocs.version>
26+
<spring-restdocs.version>1.0.0.RC1</spring-restdocs.version>
2727
</properties>
2828
<scm>
2929
<url>http://github.com/spring-projects/spring-boot</url>
@@ -199,7 +199,7 @@
199199
</dependency>
200200
<dependency>
201201
<groupId>org.springframework.restdocs</groupId>
202-
<artifactId>spring-restdocs</artifactId>
202+
<artifactId>spring-restdocs-mockmvc</artifactId>
203203
<version>${spring-restdocs.version}</version>
204204
</dependency>
205205
<dependency>

0 commit comments

Comments
 (0)