• 카테고리

    질문 & 답변

  • 세부 분야

    백엔드

  • 해결 여부

    미해결

REST Docs 관련 질문

23.12.02 14:42 작성 23.12.02 15:00 수정 조회수 404

0

안녕하세요. 강의를 들으면 실습하던중 강의와 다른 내용이 있어서 질문 드립니다.

 

Spring REST Docs를 만들어내는 과정에서 gradle의 build나 asciidoctor 태스크를 실행했는데, build 폴더에 변환된 index.html이 생성이 되지 않습니다.

 

강의에서 사용하는 환경과 다른점은 스프링부트 3이상 버전을 사용한다는 점밖에 없고, 운영체제, 나머지 build.gradle이나 테스트 코드는 모두 동일한데, 변환된 html이 생성되지 않는 이유가 있을까요?

+ 추가로 build 시에 생성되는 bootJar 파일을 압축을 해제해서 보았더니 내부의 BOOT-INF/classes/static 에도 index.html 파일이 들어가있지 않았습니다.

course-thumbnail

Practical Testing: 실용적인 테스트 가이드

Spring REST Docs

강의실 바로가기

답변 2

·

답변을 작성해보세요.

0

박우빈님의 프로필

박우빈

지식공유자

2023.12.10

안녕하세요, 세승님! :)

저도 강의 프로젝트를 부트 3 이상 버전으로 올려서 테스트해 보았는데, 문제 없이 문서가 잘 생성되었는데요.
단순히 부트 버전의 문제가 아닐 수도 있을 것 같은데, 이런 경우 asciidoctor 플러그인이나 output 경로 등을 하나씩 점검해보는 수밖에 없을 것 같아요.
(asciidoctor 태스크 단계에서 결과물이 만들어지지 않았어서 bootJar로 빌드한 jar 파일에도 index.html이 없는걸 거예요. 우리가 설정한 태스크 의존관계가 asciidoctor -> bootJar여서요. ㅎㅎ)

한번 시도해보시고, 정 어려우시면 작성하신 프로젝트 전체를 압축해서 올려주시면 확인해 보겠습니다.

감사합니다. :)

세승님의 프로필

세승

질문자

2023.12.12

프로젝트 전체를 한번 더 검토해본 결과, 프로젝트 내의 디렉터리 이름에 누락을 발견해서, 해당 부분을 수정하고 실행하였더니 정상적으로 동작하였습니다. 친절한 답변 감사합니다 :)

0

인프런 AI 인턴님의 프로필

인프런 AI 인턴

2023.12.04

안녕하세요, 인프런 AI 인턴입니다.

Spring Boot 3 버전에서 Spring REST Docs와 관련해 문서가 제대로 생성되지 않는 문제를 겪으시는군요.

Spring Boot 버전이 업데이트되면서 생긴 호환 문제일 수 있습니다. 이와 관련하여 공식 문서에서 테스트 관련 가이드를 확인하시는 것이 좋을 것 같습니다. Spring Boot 3.1.5 버전에서 제공하는 테스트 관련 유틸리티와 지원 클래스, 테스트 종속성을 제공하는 스타터에 대한 정보는 아래 링크에서 확인할 수 있습니다.

또한, Spring REST Docs는 Asciidoctor를 이용해 테스트 결과를 문서화합니다. Gradle 빌드 설정이 올바른지, Asciidoctor 플러그인이 제대로 구성되었는지 확인하셔야 합니다. 만약 문제가 지속된다면 Spring Boot의 새로운 버전에서 변경된 설정이나 추가된 사항이 없는지 확인해보시기 바랍니다.

추가로 내부 BOOT-INF/classes/static에서 생성되어야 할 index.html 파일이 없는 경우, REST Docs 설정을 다시 검토하거나, 문서 생성 과정에서 발생한 오류 메시지 등을 참고하여 문제를 진단해보시는 것을 추천드립니다.

아울러, 강의에서 다루지 않는 부분이나 최신 버전의 Spring Boot 변화에 관한 특별한 케이스는 Spring Boot 커뮤니티, Stack Overflow에 spring-boot 태그와 함께 질문 등록을 해보시는 것도 좋은 방법입니다. 해당 커뮤니티에서는 유사한 문제를 경험한 다른 개발자들의 해결 방안을 찾을 수도 있습니다.

이상의 링크와 정보를 참고하여 문제를 해결해보시기 바랍니다.

이 글과 비슷한 Q&A