REST API - Spring - REST DOCS 문서 빌드하기 Maven Plugin 추가 org.asciidoctor asciidoctor-maven-plugin 1.5.3 generate-docs prepare-package process-asciidoc html book org.springframework.restdocs spring-restdocs-asciidoctor ${spring-restdocs.version} org.springframework.boot spring-boot-maven-plugin maven-resources-plugin 2.7 copy-resources prepare-package copy-resources ${project.build.outputDirectory}/..
RESTAPI - Spring - REST DOCS 링크 필드 헤더 문서화
REST API - Spring - REST DOCS 링크_필드_헤더 문서화 요청 필드와, 헤더정보, 응답의 필드와 링크정보 에 대한 문서화가 필요하다. 필요한 링크정보 self query-events update-events profile 문서화 테스트 코드 links(): 링크에 대한 문서화 linkWithRel(): 링크와 리소스와의 관계를 정의 description(): 링크에 대한 설명 requestHeaders(): 요청 헤더에 대한 문서화 headerWithName(): 헤더의 이름 description(): 헤더에 대한 설명 requestFields(): 요청 필드에 대한 문서화 fieldWithPath(): 요청 필드의 Path 명 description(): 필드에 대한 설명 respon..
RESTAPI - Spring - REST Docs 요청_응답 문서화
REST API - Spring - REST DOCS_요청_본문_문서화 REST Docs 자동설정 @AutoConfigureRestDocs Spring Boot를 사용한다면 별다른 설정 없이 @AutoConfigureRestDocs 애노테이션만 사용하면 Rest Docs를 사용할 수 있다. @AutoConfigureRestDocs 간단한 Snippets 생성 코드 .andDo(document("create-event")): create-event 라는 이름의 snippets를 생성하도록 코드를 수정한다. 테스트를 실행하면 create-evnet snippets가 생성된다. Snippets 생성 위치 Spring - Rest Docs를 사용하여 테스트 코드를 실행하면 기본적으로 target/generate..
REST API - Spring - REST DOCS 소개 SpringMVC TEST를 사용해서 RESTAPI 문서의 일부를 생성할때 유용한 라이브러리 https://docs.spring.io/spring-restdocs/docs/2.0.3.RELEASE/reference/html5/ JAVA 8 이상 Spring 5 까지 지원 Snippets 생성한 TEST를 실행할때 사용한 헤더, 파라메터 값 등을 문서 조각이라고 부른다. 이러한 문서 조각들을 Snippets 라고 한다. 문서 조각들을 활용하여 REST API Document 를 HTML로 완성 가능하다. Asciidoctor Spring - REST DOCS 는 Asciidoctor 를 사용한다. plain/text로 작성한 문서를 Asciidoc..