Repolode
제출하기
springdoc

springdoc/springdoc-openapi

런타임에 컨트롤러를 분석해 Spring Boot 앱의 OpenAPI 3 문서와 Swagger UI 또는 Scalar 페이지를 생성합니다.

대체할 수 있는 제품:SpringFox

GitHub에서 보기웹사이트
스타
3,746
포크
612
열린 이슈
3
마지막 커밋
16시간 전

어떤 프로젝트인가요?

springdoc-openapi는 런타임에 컨트롤러, 설정, 검증 어노테이션 및 Bean Validation 제약 조건을 분석하는 Spring Boot 애플리케이션용 Java 라이브러리입니다. OpenAPI 3 명세를 JSON과 YAML로 제공하고, 대화형 Swagger UI 또는 Scalar 페이지도 함께 제공합니다. 스타터 의존성 하나만 추가하면 바로 사용할 수 있으며, 별도의 필수 설정은 없습니다.

Spring Web MVC와 Spring WebFlux를 지원하며 함수형 엔드포인트도 사용할 수 있습니다. Spring Security, OAuth 2, Spring Data REST, Spring HATEOAS 및 Actuator와 통합됩니다. Kotlin, Groovy, Javadoc을 지원하고, MCP를 통해 API를 AI 에이전트용 도구로 노출할 수도 있습니다. Maven 및 Gradle 플러그인으로 빌드 시점에 명세를 생성할 수 있으며, GraalVM 네이티브 이미지도 지원합니다.

이 프로젝트는 Java 17 이상에서 Spring Boot 4.x를 대상으로 합니다. Spring Boot 3용으로는 2.x 라인을 유지하고 있으며, 1.x는 더 이상 오픈 소스 지원을 받지 않습니다.

핵심 기능

  • 01Spring Boot 코드에서 런타임에 OpenAPI 3 명세를 JSON과 YAML 형식으로 생성합니다.
  • 02API를 둘러볼 수 있는 Swagger UI 또는 Scalar 페이지를 제공합니다.
  • 03Spring Web MVC, WebFlux 및 함수형 엔드포인트를 지원합니다.
  • 04Spring Security, OAuth 2, Spring Data REST 및 HATEOAS와 통합됩니다.
  • 05@NotNull, @Min, @Max, @Size와 같은 Bean Validation 어노테이션을 읽습니다.
  • 06빌드 시점에 명세를 생성하는 Maven 및 Gradle 플러그인을 제공합니다.

활용 사례

  • OpenAPI 파일을 직접 작성하지 않고 Spring Boot로 만든 REST API를 문서화합니다.
  • 프런트엔드 팀이나 외부 팀이 엔드포인트를 직접 시험해 볼 수 있는 대화형 페이지를 제공합니다.
  • MCP를 통해 Spring API를 AI 에이전트용 도구로 노출합니다.
  • 클라이언트 코드 생성이나 계약 검증을 위해 빌드 중 OpenAPI 파일을 생성합니다.

포함된 컬렉션

로그인, SSO & 신원 인증 서버

토픽

#java#spring-boot#openapi#swagger-ui#rest-api#api-documentation#json-format#kotlin#oauth2#openapi-spec

자주 묻는 질문

springdoc-openapi은(는) 무엇인가요?
런타임에 컨트롤러를 분석해 Spring Boot 앱의 OpenAPI 3 문서와 Swagger UI 또는 Scalar 페이지를 생성합니다. springdoc-openapi는 런타임에 컨트롤러, 설정, 검증 어노테이션 및 Bean Validation 제약 조건을 분석하는 Spring Boot 애플리케이션용 Java 라이브러리입니다. OpenAPI 3 명세를 JSON과 YAML로 제공하고, 대화형 Swagger UI 또는 Scalar 페이지도 함께 제공합니다. 스타터 의존성 하나만 추가하면 바로 사용할 수 있으며, 별도의 필수 설정은 없습니다.
springdoc-openapi은(는) 무료로 사용할 수 있나요? 라이선스는 무엇인가요?
springdoc-openapi은(는) Apache-2.0 라이선스의 오픈소스입니다. 상업용 제품에 사용하기 전에 라이선스 조건을 확인하세요.
springdoc-openapi은(는) 아직 유지보수되고 있나요?
활발히 유지보수 중. springdoc-openapi의 마지막 커밋은 2026년 11월 6일입니다.
springdoc-openapi은(는) 어디에 사용할 수 있나요?
OpenAPI 파일을 직접 작성하지 않고 Spring Boot로 만든 REST API를 문서화합니다. 프런트엔드 팀이나 외부 팀이 엔드포인트를 직접 시험해 볼 수 있는 대화형 페이지를 제공합니다. MCP를 통해 Spring API를 AI 에이전트용 도구로 노출합니다. 클라이언트 코드 생성이나 계약 검증을 위해 빌드 중 OpenAPI 파일을 생성합니다.
springdoc-openapi은(는) 어디서 받을 수 있나요?
소스 코드와 설치 방법은 GitHub에 있습니다: https://github.com/springdoc/springdoc-openapi

요약은 프로젝트 README를 바탕으로 AI가 작성했습니다. GitHub 통계는 매일 갱신됩니다.

관련 프로젝트