restdocs html 변환 문제

Lee·2023년 10월 23일
0

서론

개인 프로젝트 진행 중 restdocs의 adoc 파일을 html 파일로 변경할 때 발생한 문제에 대해 기록한다.

상황

build를 진행할 경우 테스트 코드를 동작시켜 API 문서를 HTML 파일로 생성하도록 구현했으나 생성되지 않음

문제

먼저 설정 상의 문제 또는 버전 상의 문제가 발생했을 것을 우선적으로 고려하여 공식문서를 찾아 문제 해결 시도
-> 실패

작성한 adoc 파일에 문제가 있는지 확인하여 문제 해결 시도
-> 실패

docs 디렉터리 위치 문제
설정은 src/docs로 제대로 했으나 실제 docs 디렉터리의 위치가 src/main/docs로 설정함

해결

docs 디렉터리의 경로를 src/main/docs -> src/docs로 변경하여 해결

profile
발전하고 싶은 백엔드 개발자

0개의 댓글