0308 - 0314

0308 - pull request

1. Fork
2. clone, remote
3. branch
4. add, commit, push
5. pull request
6. merge pull request

---

0309 - markdown 활용 - readme.md / git profile

마크다운 웹에디터

• https://dillinger.io/

HITS

• https://hits.seeyoufarm.com/

Badge

• https://shields.io/
• https://simpleicons.org/

Table Generator

• https://www.tablesgenerator.com/markdown_tables

Git-Hub Stats

• https://github.com/anuraghazra/github-readme-stats

Emoji

• https://www.webfx.com/tools/emoji-cheat-sheet/

---

0310 - mockMvc

실제 객체와 비슷하지만 테스트에 필요한 기능만 가지는 가짜 객체를 만들어서 어플리케이션 서버에 배포하지 않고도 스프링 MVC 동작을 재현할 수 있는 클래스를 의미합니다.

1. Controller에 대한 Test클래스 생성
2. 테스트 메소드 실행전 셋업 메소드

	private MockMvc mockMvc;

    @Autowired
    private WebApplicationContext ctx;

	@BeforeEach
	public void setup(){
		this.mockMvc = MockMvcBuilders.webAppContextSetup(ctx).build();
	}
    // 필터 추가 또는 alwayDo 옵션 추가
    // this.mockMvc = MockMvcBuilders.webAppContextSetup(ctx)
    //             .addFilters(new CharacterEncodingFilter("UTF-8", true))
    //             .alwaysDo(print())
    //             .build();
}

3. MockMvc 메소드 확인
   • .perform()
     • get(),post()
     • header
     • param()
     • accept()
     • contentType()
   • ResultActions
     • andExpert : 예상값 검증
     • andDo : 요청에 대한 처리
     • andReturn : 테스트한 결과 객체를 받을 때

@Test
    public void getStudyTest() throws Exception {
        mockMvc.perform(get(BASE_URL+"/{seq}", 1L)
                .header("Authorization", "Bearer " + loginedToken)
                .accept(MediaTypes.HAL_JSON_VALUE)
                .contentType(MediaTypes.HAL_JSON_VALUE))
                .andDo(print())
                .andExpect(status().isOk())
                .andDo()
    }

---

0311 - Spring REST Docs

API문서 작성 자동화 도구
대표적으로 Swagger, Spring Rest Docs

Asciidocor

Adoc 파일을 활용하여 html 문서를 만들어주는 도구

• 의존성 및 플러그인 추가

<plugin>
                <groupId>org.asciidoctor</groupId>
                <artifactId>asciidoctor-maven-plugin</artifactId>
                <version>1.5.8</version>
                <executions>
                    <execution>
                        <id>generate-docs</id>
                        <phase>prepare-package</phase>
                        <goals>
                            <goal>process-asciidoc</goal>
                        </goals>
                        <configuration>
                            <backend>html</backend>
                            <doctype>book</doctype>
                        </configuration>
                    </execution>
                </executions>
                <dependencies>
                    <dependency>
                        <groupId>org.springframework.restdocs</groupId>
                        <artifactId>spring-restdocs-asciidoctor</artifactId>
                        <version>${spring-restdocs.version}</version>
                    </dependency>
                </dependencies>
            </plugin>

예제

• 테스트 코드

@WebMvcTest(PostController.class)
class PostControllerTest {

    @Autowired
    private MockMvc mvc;

    @MockBean
    private PostService postService;

    @Test
    public void create() throws Exception {
        final PostResponse post = PostResponse.builder()
                .id(1L)
                .title("first_post")
                .content("hello_my_world")
                .build();
        given(postService.createPost(any())).willReturn(post);

        mvc.perform(post("/posts")
                .accept(MediaType.APPLICATION_JSON)
                .contentType(MediaType.APPLICATION_JSON)
                .content("{\"title\":\"first_post\",\"content\":\"hello_my_world\"}"))
                .andExpect(status().isCreated())
                .andExpect(header().stringValues("location", "/posts/" + 1L))
                .andDo(print());
    }
    ...
}

• Documentation 작업
  • 테스트 모듈안에 별도의 패키지 생성하고 Documentation을 작( 테스트 코드에 이어 작성해도 되지만, 따로 작성하여 관리)

public class PostDocumentation {
    public static RestDocumentationResultHandler createPost() {
        return document("posts/create",
                requestFields(
                        fieldWithPath("title").type(JsonFieldType.STRING).description("This is post title."),
                        fieldWithPath("content").type(JsonFieldType.STRING).description("This is post content")
                )
        );
    }
    ...
}

• mockMvc에 Documentation 사용 필터 추가

    @BeforeEach
    public void setUp(WebApplicationContext webApplicationContext, RestDocumentationContextProvider restDocumentation) {
        mvc = MockMvcBuilders.webAppContextSetup(webApplicationContext)
                .addFilter(new ShallowEtagHeaderFilter())
                .apply(documentationConfiguration(restDocumentation))
                .build();
    }

    // 각 테스트 마지막에 다음과 같이 .andDo(PostDocumentation.xx)를 호출해준다.
    @Test
    public void create() throws Exception {
        ...
        mvc.perform(post("/posts")
                .accept(MediaType.APPLICATION_JSON)
                .contentType(MediaType.APPLICATION_JSON)
                .content("{\"title\":\"first_post\",\"content\":\"hello_my_world\"}"))
                .andExpect(status().isCreated())
                .andExpect(header().stringValues("location", "/posts/" + 1L))
                .andDo(print())
                .andDo(PostDocumentation.createPost()); // 추가
    }

• 문서 스펙 정의를 api-guide.adoc 파일을 추가
  • src 폴더 아래에 documentation>asccidoc>api-guide.adoc 파일 추가
  • api-guide.adoc 양식

  ifndef::snippets[]
:snippets: ../../../build/generated-snippets
endif::[]
:doctype: book
:icons: font
:source-highlighter: highlightjs
:toc: left
:toclevels: 2
:sectlinks:
:operation-http-request-title: Example Request
:operation-http-response-title: Example Response

[[resources]]
= Resources

[[resources-posts]]
== Post

[[resources-posts-create]]
=== 포스트 추가
operation::posts/create[snippets='http-request,http-response,request-fields,request-body']

[[resources-posts-getAll]]
=== 포스트 전체 조회
operation::posts/getAll[snippets='http-request,http-response,response-body']

[[resources-posts-get]]
=== 포스트 조회
operation::posts/get[snippets='http-request,http-response,response-body']

[[resources-posts-update]]
=== 포스트 수정
operation::posts/update[snippets='http-request,http-response,request-fields,request-body']

[[resources-posts-delete]]
=== 포스트 삭제
operation::posts/delete[snippets='http-request,http-response']

• build test

0312 - Spring HATEOAS

Hypermedia As The Engine Of Application State
RESTful API를 사용하는 클라이언트가 전적으로 서버와 동적인 상호작용이 가능하도록 하는 것
클라이언트가 서버로부터 어떠한 요청을 할 때, 요청에 필요한(의존되는) URI를 응답에 포함시켜 반환

Content Type

• ContentType을 application/hal+json으로 전달하면 클라이언트에서는 _links 필드에 링크 정보가 있다고 예상할 수 있다.

예제

@PostMapping("/employees")
ResponseEntity<?> newEmployee(@RequestBody Employee newEmployee) {

  EntityModel<Employee> entityModel = assembler.toModel(repository.save(newEmployee));

  return ResponseEntity //
      .created(entityModel.getRequiredLink(IanaLinkRelations.SELF).toUri()) //
      .body(entityModel);
}

https://spring.io/guides/tutorials/rest/

0313 - Reverse Proxy

컴퓨터 네트워크에서 리버스 프록시란 하나 이상의 서버로 부터 클라이언트를 대신해서 리소스를 검색하는 프록시 서버, 서버가 클라이언트에게 접촉하는것을 중개

1. Load Balancing
2. Web acceleration
3. Security and anonymity

0314 - API 명세서 자동 생성

Spring Rest Docs

1. 테스트 케이스 작성
2. 테스트 실행
3. 생성된 snippets 문서 확인

curl-request.adoc : 호출에 대한 curl 명령을 포함 하는 문서
httpie-request.adoc : 호출에 대한 http 명령을 포함 하는 문서
http-request.adoc : http 요청 정보 문서
http-response.adoc : http 응답 정보 문서
request-body.adoc : 전송된 http 요청 본문 문서
response-body.adoc : 반환된 http 응답 본문 문서
request-parameters.adoc : 호출에 parameter 에 대한 문서
path-parameters.adoc : http 요청시 url 에 포함되는 path parameter 에 대한 문서
request-fields.adoc : http 요청 object 에 대한 문서
response-fields.adoc : http 응답 object 에 대한 문서

4. API 명세서 작성

• 스니펫 문서 경로 지정

ifndef::snippets[]
:snippets: ../../../target/generated-snippets
endif::[]

• 원하는 스니펫 추가

include::{snippets}/user-controller-test/get-list/curl-request.adoc[]

5. maven install

• html로 반환 / api 명세서 복사 설정

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    ...
    <build>
        <plugins>
            ...
            <!-- 1. API 명세서를 html로 변환 -->
            <plugin>
                <groupId>org.asciidoctor</groupId>
                <artifactId>asciidoctor-maven-plugin</artifactId>
                <version>1.5.3</version>
                <executions>
                    <execution>
                        <id>generate-docs</id>
                        <phase>prepare-package</phase>
                        <goals>
                            <goal>process-asciidoc</goal>
                        </goals>
                        <configuration>
                            <backend>html</backend>
                            <doctype>book</doctype>
                        </configuration>
                    </execution>
                </executions>
                <dependencies>
                    <dependency>
                        <groupId>org.springframework.restdocs</groupId>
                        <artifactId>spring-restdocs-asciidoctor</artifactId>
                        <version>2.0.2.RELEASE</version>
                    </dependency>
                </dependencies>
            </plugin>

            <!-- 2. html 로 변환된 API 명세서를 static 영역으로 복사 -->
            <plugin>
                <artifactId>maven-resources-plugin</artifactId>
                <version>3.0.1</version>
                <executions>
                    <execution>
                        <id>copy-resources</id>
                        <phase>prepare-package</phase>
                        <goals>
                            <goal>copy-resources</goal>
                        </goals>
                        <configuration>
                            <outputDirectory>
                                ${project.build.outputDirectory}/static/docs
                            </outputDirectory>
                            <resources>
                                <resource>
                                    <directory>
                                        ${project.build.directory}/generated-docs
                                    </directory>
                                </resource>
                            </resources>
                        </configuration>
                    </execution>
                </executions>
            </plugin>
            ...
        </plugins>
    </build>
    ...
</project>

6. html 문서 확인