Spring-Rest-Docs적용기

기존 개인프로젝트나 회사에서 API를 명세하기 위해 springdoc-openapi 라이브러리를 사용해 문서를 생성하고 springdoc-openapi 라이브러리가 지원하는 Swagger-ui 를 통해 사용자에게 제공하는 방식을 사용하고있었다.최근들어 회사에서 자동화에

Spirng Boot 애플리케이션을 OpenAPI3(이전의 Swagger) 와 통합하는 라이브러리Spring Boot 컨트롤러 및 엔드포인트를 기반으로 API에 대한 문서를 자동으로 생성한다.spring-boot v3 이상 : springdoc-openapi v2spr

Spring Rest Docs를 적용하기 위해 필요한 코드만 집중적으로 설명합니다. 적용을 하기로 마음먹은 후 가장 첫번째로 build.gradle의 설정을 바꾸는 일이였다. 즉, 환경설정이라고 이해하면 편할 것 같다. build.gradle 설정 위 설정을 완료

지난 포스트들의 결과로 Spring Rest Docs 를 적용하였다.하지만...장점이 있으면 단점도 있는 법 테스트 중심의 API 문서화의 결과로 완성된 API 문서는 기존 계속 사용해왔던 Swagger-UI 처럼 사용자 친화적? 이지 않다.필자의 개인적인 생각으로는