강사님 Swagger에 질문드립니다.

생산성을 향상시키는 스프링부트 기반의 API 템플릿 프로젝트 구현

API 문서화 (1) - Swagger 설정

24.02.08 12:42 작성

185

- 학습 관련 질문을 남겨주세요. 상세히 작성하면 더 좋아요!
- 먼저 유사한 질문이 있었는지 검색해보세요.
- 서로 예의를 지키며 존중하는 문화를 만들어가요.
- 잠깐! 인프런 서비스 운영 관련 문의는 1:1 문의하기를 이용해주세요.

springfox 버전의 스웨거는 2020년 이후로 업데이트가 종료된 후로

springdoc의 스웨거를 사용하는데 (업데이트 지속)

어떤걸 의존성 추가해야하는게 맞는것일지 고민이 됩니다.

spring-boot jpa web-api

답변 2

구파고

지식공유자

2024. 02. 13. 20:53

안녕하세요! 말씀하신것처럼 springdoc를 사용하는게 더 좋을꺼 같습니다.

스프링부트도 버전이 계속 신규로 나오고 다른 라이브러리도 계속 변경될 것 인데 가능하면 최신버전으로 바꾸시면 좋을꺼 같네요!

강의에서 진행했던 기능을 동일하게 springdoc에서도 어떻게 사용하는지 정도만 한번 찾아보면 될꺼 같습니다.

인프런 AI 인턴

2024. 02. 10. 12:46

안녕하세요, 인프런 AI 인턴입니다.
두잇베스트님, 질문하신 사항에 대해 안내드리겠습니다.

Spring Boot 기반의 프로젝트에서 Swagger를 사용하고자 하실 때, 과거에는 springfox를 사용했으나 현재는 springdoc-openapi를 많이 사용합니다. springfox 프로젝트는 2020년 이후로 업데이트가 종료된 반면에, springdoc-openapi 프로젝트는 지속적으로 업데이트되고 있어 현재 상태에 맞는 의존성을 추가하는 것이 좋습니다.

Spring Boot 프로젝트에 springdoc-openapi를 추가하는 방법은 Gradle 혹은 Maven을 사용하는 프로젝트 설정 파일에 아래와 같이 의존성을 추가하면 됩니다.

Maven을 사용하는 경우:

<dependency>
    <groupId>org.springdoc</groupId>
    <artifactId>springdoc-openapi-ui</artifactId>
    <version>버전을 확인해 주세요</version>
</dependency>

Gradle을 사용하는 경우:

implementation 'org.springdoc:springdoc-openapi-ui:버전을 확인해 주세요'

스웨거를 사용하여 API 문서화를 하는 것은 개발 생산성을 향상시키고, API의 사용성을 향상시키는 데 중요한 역할을 합니다. 추가적으로 스프링부트와 관련하여 더 깊이있는 지식이 필요하시다면 “Spring Boot Reference Documentation”의 18. “How-to” Guides 섹션을 살펴볼 수 있습니다. 해당 문서는 여기에서 찾아보실 수 있습니다:
https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#howto

도움이 되셨기를 바랍니다.

인프런 커뮤니티 질문&답변

강사님 Swagger에 질문드립니다.