Spring Rest Docs (3) - Validation 규칙을 API 문서에 추가하기 (restdocs-api-spec)

이 글에서 사용한 전체 코드는 다음 레포지토리에 존재합니다.https://github.com/HeeChanN/java-play-ground/tree/main/practice_rest_docs java-play-ground/practice_rest_docs at main · HeeChanN/java-play-groundjava로 이것저것. Contribute to HeeChanN/java-play-ground development by creating an account on GitHub.github.com 1. jakarta.validation.* 을 지원하지 않는 문제 JDK 17, Spring Boot 3.x 버전을 사용하면 Bean Validation을 jakarta.* 의존성을 사용한다. 공식문..

• format_list_bulleted Spring Boot
• · 2025. 7. 8.
• textsms

Spring Rest Docs (2) - API 문서에 디자인 입히기 (swagger, redoc)

Spring Rest Docs로 나온 Snippet들을 이용하여 API 문서를 만들 때, adoc 파일을 작성하여 만드는 방법 이외에 swagger 혹은 redoc을 이용하여 만드는 방법이 있습니다. 이 방법들을 사용하면 따로 adoc 파일을 작성하지 않아도 된다는 큰 장점이 존재해서 빠르게 API 문서를 만들어야 한다면 도입해 볼만하다고 생각합니다. 1. restdocs-api-spec 설정 추가`swagger`나 `redoc`을 사용하기 위해서 기존의 Snippet들을 json으로 만들어 줘야하는데 이를 자동으로 변환하기 위해 `restdocs-api-spec` 플러그인 설정을 Gradle 빌드 스크립트에 추가한다. restdocs-api-spec의 장점은 Spring Rest Docs 기반으로 작..

• format_list_bulleted Spring Boot
• · 2025. 7. 8.
• textsms