Skip to content

Commit 5e2cd82

Browse files
zacscodingzacscoding
committed
testing spring rest docs
1 parent 525c30f commit 5e2cd82

File tree

24 files changed

+1324
-38
lines changed

24 files changed

+1324
-38
lines changed

‎book/rest-api-demo/src/main/java/demo/events/EventController.java‎

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,6 @@
33
import static org.springframework.hateoas.mvc.ControllerLinkBuilder.linkTo;
44

55
import demo.accounts.Account;
6-
import demo.accounts.AccountAdapter;
76
import demo.accounts.CurrentUser;
87
import demo.common.ErrorsResource;
98
import java.net.URI;
@@ -21,10 +20,6 @@
2120
import org.springframework.hateoas.mvc.ControllerLinkBuilder;
2221
import org.springframework.http.HttpStatus;
2322
import org.springframework.http.ResponseEntity;
24-
import org.springframework.security.core.Authentication;
25-
import org.springframework.security.core.annotation.AuthenticationPrincipal;
26-
import org.springframework.security.core.context.SecurityContextHolder;
27-
import org.springframework.security.core.userdetails.User;
2823
import org.springframework.stereotype.Controller;
2924
import org.springframework.validation.Errors;
3025
import org.springframework.web.bind.annotation.GetMapping;
@@ -33,7 +28,6 @@
3328
import org.springframework.web.bind.annotation.PutMapping;
3429
import org.springframework.web.bind.annotation.RequestBody;
3530
import org.springframework.web.bind.annotation.RequestMapping;
36-
import sun.plugin.liveconnect.SecurityContextHelper;
3731

3832
/**
3933
* https://github.com/keesun/study/tree/master/rest-api-with-spring

‎book/rest-api-demo/src/test/java/demo/DemoApplicationTests.java‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,14 @@
11
package demo;
22

3+
import org.junit.Ignore;
34
import org.junit.Test;
45
import org.junit.runner.RunWith;
56
import org.springframework.boot.test.context.SpringBootTest;
67
import org.springframework.test.context.junit4.SpringRunner;
78

89
@RunWith(SpringRunner.class)
910
@SpringBootTest
11+
@Ignore
1012
public class DemoApplicationTests {
1113

1214
@Test

‎book/rest-api-demo/src/test/java/demo/events/EventControllerTests.java‎

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@
3131
import java.util.stream.IntStream;
3232
import org.hamcrest.Matchers;
3333
import org.junit.Before;
34+
import org.junit.Ignore;
3435
import org.junit.Test;
3536
import org.springframework.beans.factory.annotation.Autowired;
3637
import org.springframework.hateoas.MediaTypes;
@@ -270,17 +271,16 @@ public void queryEventsWithAuthentication() throws Exception {
270271
@TestDescription("기존의 이벤트를 하나 조회하기")
271272
public void getEvent() throws Exception {
272273
// Given
273-
Event event = generateEvent(1);
274+
Event event = this.generateEvent(100);
274275

275276
// When & Then
276-
mockMvc.perform(get("/api/events/{id}", event.getId()))
277+
this.mockMvc.perform(get("/api/events/{id}", event.getId()))
277278
.andExpect(status().isOk())
278279
.andExpect(jsonPath("name").exists())
279280
.andExpect(jsonPath("id").exists())
280281
.andExpect(jsonPath("_links.self").exists())
281282
.andExpect(jsonPath("_links.profile").exists())
282-
.andDo(document("get-an-event"))
283-
;
283+
.andDo(document("get-an-event"));
284284
}
285285

286286
@Test
@@ -295,23 +295,22 @@ public void getEvent404() throws Exception {
295295
@TestDescription("이벤트를 정상적으로 수정하기")
296296
public void updateEvent() throws Exception {
297297
// Given
298-
Event event = generateEvent(200);
299-
EventDto eventDto = modelMapper.map(event, EventDto.class);
300-
eventDto.setName("Updated-" + eventDto.getName());
298+
Event event = this.generateEvent(200);
299+
300+
EventDto eventDto = this.modelMapper.map(event, EventDto.class);
301+
String eventName = "Updated Event";
302+
eventDto.setName(eventName);
301303

302304
// When & Then
303-
mockMvc.perform(
304-
put("/api/events/{id}", event.getId())
305-
.header(HttpHeaders.AUTHORIZATION, getBearerToken())
306-
.contentType(MediaType.APPLICATION_JSON_UTF8)
307-
.content(objectMapper.writeValueAsString(eventDto)))
305+
this.mockMvc.perform(put("/api/events/{id}", event.getId())
306+
.header(HttpHeaders.AUTHORIZATION, getBearerToken())
307+
.contentType(MediaType.APPLICATION_JSON_UTF8)
308+
.content(this.objectMapper.writeValueAsString(eventDto)))
308309
.andDo(print())
309310
.andExpect(status().isOk())
310-
.andExpect(jsonPath("name").value(eventDto.getName()))
311+
.andExpect(jsonPath("name").value(eventName))
311312
.andExpect(jsonPath("_links.self").exists())
312-
.andDo(document("update-event"))
313-
// TODO :: 문서화
314-
;
313+
.andDo(document("update-event"));
315314
}
316315

317316
@Test
@@ -331,6 +330,7 @@ public void updateEvent400Empty() throws Exception {
331330
.andExpect(status().isBadRequest());
332331
}
333332

333+
@Ignore
334334
@Test
335335
@TestDescription("입력값이 잘못된 경우에 이벤트 수정 실패")
336336
public void updateEvent400Wrong() throws Exception {

‎springboot-curator-demo/README.md‎

Lines changed: 1 addition & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,7 @@
33

44
> ### Basic usage
55
6-
<<<<<<< HEAD
7-
<a href="src/test/java/demo/curator.CuratorBasicUsageTest.java">See</a>
8-
=======
96
<a href="src/test/java/demo/curator/CuratorBasicUsageTest.java">See</a>
10-
>>>>>>> 002563b7770a84f6688053d5255f03b09ac31adf
117

128
```
139
usage_retryPolicies() / usage_retryPoliciesAsync()
@@ -21,16 +17,7 @@ usage_sharedLock() / usage_counter()
2117
> ### Shared lock demo
2218
2319
- <a href="src/main/java/demo/lock">Server side (receive tasks)</a>
24-
- <a href="src/test/java/demo/LockTaskPushTest.java">Client side (push
25-
<<<<<<< HEAD
26-
tasks) </a>
27-
28-
> Master slave demo
29-
30-
- working..
31-
~~~~
32-
=======
33-
tasks) </a>
20+
- <a href="src/test/java/demo/LockTaskPushTest.java">Client side (push tasks) </a>
3421

3522
---
3623

@@ -67,4 +54,3 @@ $ java -Dlock.client.id=0003 -Dserver.port=8083 -Dspring.profiles.active=master-
6754
```
6855

6956
---
70-
>>>>>>> 002563b7770a84f6688053d5255f03b09ac31adf

‎springboot-elasticsearch-demo/src/main/java/demo/configuration/ElasticsearchConfiguration.java‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,6 @@ public RestHighLevelClient restHighLevelClient() {
5050
@Override
5151
public void afterContextLoaded() throws Exception {
5252
ElasticsearchTemplate elasticsearchTemplate = elasticsearchTemplate();
53-
5453
elasticsearchTemplate.createIndexAndMapping(elasticProperties.getPersonsDocument());
5554
}
5655

‎springboot-rest-docs-demo/.gitignore‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
/target/
2+
!.mvn/wrapper/maven-wrapper.jar
3+
4+
### STS ###
5+
.apt_generated
6+
.classpath
7+
.factorypath
8+
.project
9+
.settings
10+
.springBeans
11+
.sts4-cache
12+
13+
### IntelliJ IDEA ###
14+
.idea
15+
*.iws
16+
*.iml
17+
*.ipr
18+
19+
### NetBeans ###
20+
/nbproject/private/
21+
/build/
22+
/nbbuild/
23+
/dist/
24+
/nbdist/
25+
/.nb-gradle/

‎springboot-rest-docs-demo/.mvn/wrapper/maven-wrapper.jar‎

47.2 KB
Binary file not shown.

‎springboot-rest-docs-demo/.mvn/wrapper/maven-wrapper.properties‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
distributionUrl=https://repo.maven.apache.org/maven2/org/apache/maven/apache-maven/3.5.4/apache-maven-3.5.4-bin.zip

‎springboot-rest-docs-demo/README.md‎

Lines changed: 137 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,137 @@
1+
# Spring Rest Docs demo
2+
3+
> Gererate rest docs
4+
5+
```aidl
6+
$ mvn clean install
7+
$ mvn spring-boot:run
8+
```
9+
10+
> Docs
11+
12+
![rest docs1](./assets/docs1.png)
13+
14+
15+
![rest docs2](./assets/docs1.png)
16+
17+
18+
> maven
19+
20+
```aidl
21+
...
22+
<plugin>
23+
<groupId>org.springframework.boot</groupId>
24+
<artifactId>spring-boot-maven-plugin</artifactId>
25+
</plugin>
26+
<plugin>
27+
<groupId>org.asciidoctor</groupId>
28+
<artifactId>asciidoctor-maven-plugin</artifactId>
29+
<version>1.5.3</version>
30+
<executions>
31+
<execution>
32+
<id>generate-docs</id>
33+
<phase>prepare-package</phase>
34+
<goals>
35+
<goal>process-asciidoc</goal>
36+
</goals>
37+
<configuration>
38+
<backend>html</backend>
39+
<doctype>book</doctype>
40+
<attributes>
41+
<snippets>${snippetsDirectory}</snippets>
42+
5
43+
</attributes>
44+
</configuration>
45+
</execution>
46+
</executions>
47+
<dependencies>
48+
<dependency>
49+
<groupId>org.springframework.restdocs</groupId>
50+
<artifactId>spring-restdocs-asciidoctor</artifactId>
51+
<version>2.0.3.RELEASE</version>
52+
</dependency>
53+
</dependencies>
54+
</plugin>
55+
<plugin>
56+
<artifactId>maven-resources-plugin</artifactId>
57+
<version>2.7</version>
58+
<executions>
59+
<execution>
60+
<id>copy-resources</id>
61+
<phase>prepare-package</phase>
62+
<goals>
63+
<goal>copy-resources</goal>
64+
</goals>
65+
<configuration>
66+
<outputDirectory>${project.build.outputDirectory}/static/docs
67+
</outputDirectory>
68+
<resources>
69+
<resource>
70+
<directory>${project.build.directory}/generated-docs</directory>
71+
</resource>
72+
</resources>
73+
</configuration>
74+
</execution>
75+
</executions>
76+
</plugin>
77+
...
78+
```
79+
80+
> Testing code
81+
82+
```aidl
83+
@Test
84+
public void test_getPersons() throws Exception {
85+
// given
86+
IntStream.rangeClosed(1, 30).forEach(this::savePersons);
87+
88+
// when then
89+
mockMvc.perform(get("/api/person")
90+
.param("page", "1")
91+
.param("size", "5")
92+
.param("sort", "name,DESC"))
93+
.andDo(print())
94+
.andDo(
95+
document("get-persons",
96+
requestParameters(
97+
parameterWithName("page").description("page of search"),
98+
parameterWithName("size").description("size of search"),
99+
parameterWithName("sort").description("sort of search")
100+
),
101+
responseHeaders(
102+
headerWithName(HttpHeaders.CONTENT_TYPE).description("Content type")
103+
),
104+
responseFields(
105+
fieldWithPath("content[]").type(JsonFieldType.ARRAY).description("searched content"),
106+
fieldWithPath("content[].id").type(JsonFieldType.NUMBER).description("Id of a person"),
107+
fieldWithPath("content[].name").type(JsonFieldType.STRING).description("name of a person"),
108+
fieldWithPath("content[].age").type(JsonFieldType.NUMBER).description("age of a person"),
109+
fieldWithPath("content[].hobbies").type(JsonFieldType.ARRAY).description("hobbies of a person"),
110+
111+
fieldWithPath("pageable.sort.sorted").description("sorted or not"),
112+
fieldWithPath("pageable.sort.unsorted").description("unsorted or not"),
113+
fieldWithPath("pageable.sort.empty").description("empty or not"),
114+
115+
fieldWithPath("pageable.offset").description("offset of search results"),
116+
fieldWithPath("pageable.pageSize").description("page size of search results"),
117+
fieldWithPath("pageable.pageNumber").description("page number of search results"),
118+
fieldWithPath("pageable.paged").description("paged or not"),
119+
fieldWithPath("pageable.unpaged").description("unpaged or not"),
120+
121+
fieldWithPath("totalPages").description("total pages of search results"),
122+
fieldWithPath("totalElements").description("total number of elts"),
123+
fieldWithPath("last").description("last or not"),
124+
fieldWithPath("number").description("page number"),
125+
fieldWithPath("size").description("elts size"),
126+
fieldWithPath("sort.sorted").description("sorted or not"),
127+
fieldWithPath("sort.unsorted").description("unsorted or not"),
128+
fieldWithPath("sort.empty").description("empty or not"),
129+
fieldWithPath("numberOfElements").description("elts number"),
130+
fieldWithPath("first").description("first page or not"),
131+
fieldWithPath("empty").description("empty or not")
132+
)
133+
)
134+
);
135+
}
136+
```
137+

‎springboot-rest-docs-demo/assets/docs1.png‎

108 KB
Loading

0 commit comments

Comments
 (0)