[Asciidoc] Spring REST Docs Unresolved directive Error

General Dong·2024년 9월 16일

Spring REST Docs

목록 보기
3/5

Unresolved directive Error 원인

Intellij에서는 include::{docdir}/api/login.adoc[]가 잘 인식이 된다.

그러나 빌드 후, /docs/index.html에서 보면 지정한 login.adoc 파일을 가져오지 못한다.

공식 문서에서는 {docdir}은 해당 문서가 포함된 전체 경로라고 나와 있지만, Unresolved directive 이후 나와있는 경로를 보면 index.adoc에 적은 {docdir}이 프로젝트의 루트 경로를 지정하고 있어 문제가 발생한 것이다.

Unresolved directive Error 해결

include::{docdir}/api/login.adoc[] // 처음 적은 경로 (1)

include::{docdir}/src/docs/asciidoc/api/login.adoc[] // 변경한 경로 (2)

(1) 경로를 (2) 경로로 지정하면 해결된다.
(2) 경로는 프로젝트 경로부터 지정하는 파일의 경로까지 적어주면 된다!

그러나 Intellij에서는 (2) 경로를 인식하지 못해 코드 오류로 판단한다.
그래도 빌드 후, 문서 URL로 접속하면 아래 사진과 같이 정상적인 API 문서가 나온다.

개발 중일 때는 (2) 경로를 주석처리 하고, (1) 경로를 임시로 사용하여 미리보기 기능을 보면서 작업하면 편하다!

profile
개발에 대한 기록과 복습을 위한 블로그 | Back-end Developer

0개의 댓글