사용자분들이 올리신 글들을 보면 Build를 할 경우, 설정에 따라 자동적으로 *.html 파일 출력이 이뤄진다고 적혀있었다.
하지만 아무리 Build를 눌러도 반응이 없고, 직접적으로 Task를 돌려도 반응이 없어서 다시 찾아보니, Template라는 게 필요한 것 같았다.
Templates 설정
Spring REST Docs
Document RESTful services by combining hand-written documentation with auto-generated snippets produced with Spring MVC Test, WebTestClient, or REST Assured.
docs.spring.io
위의 Spring REST Docs의 Reference Doc의 Using the Snippets 부분을 확인하면 확인할 수 있다.
본인의 경우에는 Gradle을 사용했기 때문에 src/docs/asciidoc/ 경로에 Template를 만들어줘야 src/main/resources/static/docs에 html 파일이 생성될 수 있는 것이다.
좌측처럼 asciidoc의 문법에 따라 작성하면 test 코드 통과 후 생성했던 *.adoc 파일을 import 하여 깔끔하게 docs를 생성할 수 있다.
Asciidoc 기본 사용법
Asciidoc의 기본 문법을 설명한다
narusas.github.io
Build
해당 템플릿을 제작하고, build를 시작하니 드디어 html 파일이 생성되었다.
참조
[Java]Spring REST Docs HTML이 생성되지 않을때
백기선님의 스프링부트 강좌를 수강하는중에 Spring REST Docs를 이용하여 HTML을 생성하려하는데,아무리 빌드를 해도 ascii\html\index.html이 생성되지 않았습니다. 12345678910111213141516171819202122232425262728293
blog.hodory.dev
'Server > Spring&Spring Boot' 카테고리의 다른 글
[Refactor] boolean을 사용하여 메서드 정리 (0) | 2023.04.01 |
---|---|
[Spring] @Builder 사용시, 초기화해야할 필드가 존재할 때 발생하는 에러. @Builder will ignore the initializing expression entirely (0) | 2023.03.25 |
[Spring Security] Spring Security을 추가하면 왜 로그인 화면으로 넘어가는 걸까? (0) | 2023.02.25 |
[Spring colud] open feign 사용법 (0) | 2023.02.25 |
[Thymeleaf] th:object, th:field 사용법 (0) | 2023.02.21 |