springdoc openapi
v2.7.0 released! Latest
중요: springdoc-openapi v1.8.0 은 Spring Boot 2.x 및 1.x를 지원하는 최신 오픈 소스 릴리스입니다.
이제 springdoc-openapi v1 프로젝트에 대한 확장된 지원이 2023년 이후에도 지원이 필요한 조직에 제공됩니다.
자세한 내용은 언제든지 [email protected]로 문의하세요.
springdoc-openapi Open Collective에 있습니다. 이 프로젝트를 ❤️한다면 후원자가 되는 것을 고려해 보세요.
이 프로젝트는 다음이 후원합니다.
springdoc-openapi Java 라이브러리는 Spring Boot 프로젝트를 사용하여 API 문서 생성을 자동화하는 데 도움이 됩니다. springdoc-openapi는 런타임 시 애플리케이션을 검사하여 Spring 구성, 클래스 구조 및 다양한 주석을 기반으로 API 의미를 추론하는 방식으로 작동합니다.
라이브러리는 JSON/YAML 및 HTML 형식 페이지로 문서를 자동으로 생성합니다. 생성된 문서는 swagger-api 주석을 사용하여 보완할 수 있습니다.
이 라이브러리는 다음을 지원합니다.
다음 비디오에서는 라이브러리를 소개합니다.
spring-boot v3 지원을 위해서는 springdoc-openapi v2를 사용해야 합니다.
이것은 Spring Framework 기여자(Pivotal)가 관리하지 않는 커뮤니티 기반 프로젝트입니다.
server : 서버 이름 또는 IPport : 서버 포트context-path : 애플리케이션의 컨텍스트 경로/v3/api-docs.yamlspringdoc-openapi-ui 라이브러리를 추가합니다(추가 구성이 필요하지 않음).메이븐
< dependency >
< groupId >org.springdoc</ groupId >
< artifactId >springdoc-openapi-starter-webmvc-ui</ artifactId >
< version >last-release-version</ version >
</ dependency >그래들
implementation ' org.springdoc:springdoc-openapi-starter-webmvc-ui:latest ' # swagger-ui custom path
springdoc.swagger-ui.path =/swagger-ui.htmlserver : 서버 이름 또는 IPport : 서버 포트context-path : 애플리케이션의 컨텍스트 경로/v3/api-docs.yaml메이븐
< dependency >
< groupId >org.springdoc</ groupId >
< artifactId >springdoc-openapi-starter-webmvc-api</ artifactId >
< version >last-release-version</ version >
</ dependency >그래들
implementation ' org.springdoc:springdoc-openapi-starter-webmvc-ui:latest ' # /api-docs endpoint custom path
springdoc.api-docs.path =/api-docsspringdoc-openapi 끝점을 비활성화하려면 spring-boot 구성 파일에 사용자 정의 springdoc 속성을 추가하세요. # disable api-docs
springdoc.api-docs.enabled =false문서를 자동으로 생성하려면 모든 메서드가 @ResponseStatus 주석을 사용하여 HTTP 코드 응답을 선언하는지 확인하세요.
라이브러리는 스프링 부트 애플리케이션 자동 구성 패키지를 사용하여 Spring Bean에서 OpenAPIDefinition 및 Info 주석을 검색합니다. 이러한 주석은 API 정보: 제목, 버전, 라이센스, 보안, 서버, 태그, 보안 및 externalDocs를 선언합니다. 문서 생성 성능을 향상하려면 Spring 관리 Bean 내에서 @OpenAPIDefinition 및 @SecurityScheme 주석을 선언하세요.
메이븐
< dependency >
< groupId >org.springdoc</ groupId >
< artifactId >springdoc-openapi-starter-webflux-ui</ artifactId >
< version >last-release-version</ version >
</ dependency >그래들
implementation ' org.springdoc:springdoc-openapi-starter-webmvc-ui:latest ' # swagger-ui custom path
springdoc.swagger-ui.path =/swagger-ui.html springdoc-openapi 라이브러리는 Maven 중앙 저장소에서 호스팅됩니다. 아티팩트는 다음 위치에서 액세스하여 볼 수 있습니다.
출시:
스냅샷:
springdoc-openapi는 기여자의 귀중한 기여로 인해 관련성이 있고 정기적으로 업데이트됩니다.
여러분의 지원에 감사드립니다!
