검색

54장. OpenAPI 지원을 사용하여 JAX-RS 끝점 확장

download PDF

초록

CXF OpenApiFeature(org.apache.cxf.jaxrs.openapi.OpenApiFeature)를 사용하면 간단한 구성으로 게시된 JAX-RS 서비스 끝점을 확장하여 OpenAPI 문서를 생성할 수 있습니다.

OpenApiFeature는 Spring Boot 및 Karaf 구현 모두에서 지원됩니다.

54.1. OpenApiFeature 옵션

OpenApiFeature에서 다음 옵션을 사용할 수 있습니다.

표 54.1. OpenApiFeature 작업
이름설명기본값

configLocation

OpenAPI 구성 위치

null

contactEmail

연락처 이메일+

null

contactName

연락처 이름 +

null

contactUrl

연락처 링크 +

null

Customizer

customr 클래스 인스턴스

null

description

description+

null

filterClass

보안 필터 ++

null

ignoredRoutes

모든 리소스를 스캔할 때 특정 경로 제외 ( 검사AllResources++ 참조)

null

라이센스

라이센스 +

null

licenseUrl

라이센스 URL+

null

prettyPrint

openapi.json을 생성할 때 JSON 문서++를 크게 인쇄합니다.

true

propertiesLocation

속성 파일 위치

/swagger.properties

readAllResources

@Operation++ 없이 모든 작업을 읽어 보십시오.

true

resourceClasses

검색해야 하는 리소스 클래스 목록입니다.

null

resourcePackages

리소스를 스캔해야 하는 패키지 이름 목록 ++

null

runAsFilter

필터로 기능 실행

false

scan

모든 JAX-RS 리소스를 자동으로 스캔

true

scanKnownConfigLocations

다음과 같은 알려진 OpenAPI 구성 위치(classpath 또는 파일 시스템)를 스캔합니다.

openapi-configuration.yaml
openapi-configuration.json
openapi.yaml
openapi.json

true

scannerClass

애플리케이션, 리소스 패키지, 리소스 클래스, 클래스 경로 스캔의 범위를 지정하는 데 사용되는 JAX-RS API 스캐너 클래스의 이름은 Resource Scanning 섹션을 참조하십시오.

null

securityDefinitions

보안 정의 목록+

null

supportSwaggerUi

SwaggerUI 지원

null(== true)

swaggerUiConfig

Swagger UI 구성

null

swaggerUiMavenGroupAndArtifact

SwaggerUI를 캡처하기 위한 Maven 아티팩트

null

swaggerUiVersion

SwaggerUI의 버전

null

termsOfServiceUrl

서비스 URL 추가

null

title

제목 +

null

useContextBasedConfig

설정된 경우 각 OpenApiContext 인스턴스에 대해 고유한 컨텍스트 Id가 생성됩니다( 여러 서버 끝점 사용 참조). 또한 검사 속성을 false로 설정할 수 있습니다.

false

version

version+

null

+ 옵션은 OpenAPI 클래스에 정의되어 있습니다.

++ 옵션은 SwaggerConfiguration 클래스에 정의되어 있습니다.

Red Hat logoGithubRedditYoutubeTwitter

자세한 정보

평가판, 구매 및 판매

커뮤니티

Red Hat 문서 정보

Red Hat을 사용하는 고객은 신뢰할 수 있는 콘텐츠가 포함된 제품과 서비스를 통해 혁신하고 목표를 달성할 수 있습니다.

보다 포괄적 수용을 위한 오픈 소스 용어 교체

Red Hat은 코드, 문서, 웹 속성에서 문제가 있는 언어를 교체하기 위해 최선을 다하고 있습니다. 자세한 내용은 다음을 참조하세요.Red Hat 블로그.

Red Hat 소개

Red Hat은 기업이 핵심 데이터 센터에서 네트워크 에지에 이르기까지 플랫폼과 환경 전반에서 더 쉽게 작업할 수 있도록 강화된 솔루션을 제공합니다.

© 2024 Red Hat, Inc.