목록전체 글 (114)

아카이브

[스프링 기반 REST API 개발] Spring REST Docs 문서 빌드하기

Mavn plugin 설정하기 org.asciidoctor asciidoctor-maven-plugin 1.5.8 generate-docs prepare-package process-asciidoc html book org.springframework.restdocs spring-restdocs-asciidoctor ${spring-restdocs.version} maven-resources-plugin copy-resources prepare-package copy-resources ${project.build.outputDirectory}/static/docs ${project.build.directory}/generated-docs adoc template 추가 src/main/asciidoc/in..
Spring/스프링 기반 REST API 개발 2021. 1. 6. 22:39
[스프링 기반 REST API 개발] Request/Response 필드와 헤더 문서화하기

API 문서 만들기 요청 본문 문서화: request-body 응답 본문 문서화: response-body 링크 문서화: links self query-events update-event profile 링크 추가 요청 헤더 문서화: requestHeaders 요청 필드 문서화: requestFields 응답 헤더 문서화: responseHeaders 응답 필드 문서화: responseFields links : linkWithResl() ~Headers : headerWithName ~Fields : fieldWithPath @Test @DisplayName("정상적으로 이벤트를 생성하는 테스트") void createEvent() throws Exception { EventDto eventDto = Ev..
Spring/스프링 기반 REST API 개발 2021. 1. 6. 22:21
[스프링 기반 REST API 개발] Spring REST Docs 소개, 자동 설정 및 커스터마이징

Spring REST Docs란? API 문서 작성 자동화 도구 - 성공 Test Case를 기반으로 API 스펙을 작성하기 때문에, 제품 코드를 건드릴 필요가 없다 - 문서의 조각을 만드는 것을 snippets라고 칭한다. - API 코드를 변경했을 때, Test Case가 성공하면 문서도 자동으로 바뀐다. - 추가 테스트에 대한 문서화가 강제된다. Asciidoctor ? HTML 문서 작성 도구 - Rest Docs가 문서 작성에 필요한 코드 조각을 만드는 도구라면, Asciidoctor는 Adoc 파일을 활용하여 html 문서를 만들어주는 도구이다. 테스트를 통한 snippets 생성 방법 - MockMvc(@WebMvcTest) : Contoller Layer 만 테스트하기에 속도가 빠르다. -..
Spring/스프링 기반 REST API 개발 2021. 1. 6. 22:00
이전 Prev 1 ··· 14 15 16 17 18 19 20 ··· 38 Next 다음