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

초록

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

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

54.1. OpenApiFeature 옵션

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

표 54.1. OpenApiFeature 작업
이름	설명	기본값
`basePath`	컨텍스트 루트 경로 + ( `usePathBasedConfig` 옵션 참조)	null
`연락처`	연락처 정보 +	"users@cxf.apache.org"
`description`	설명 +	"애플리케이션"
`filterClass`	보안 필터 +	null
`host`	호스트 및 포트 정보 +	null
`ignoreRoutes`	모든 리소스를 스캔할 때 특정 경로 제외 ( `검사AllResources` 옵션 참조)++	null
`라이센스`	라이센스 +	"Apache 2.0 라이센스"
`licenceUrl`	라이센스 URL+	`http://www.apache.org/licenses/LICENSE-2.0.html`
`prettyPrint`	`openapi.json` 을 생성할 때 JSON 문서를 거의 인쇄하도록 지정합니다.	false
`resourcePackage`	리소스를 검색해야 하는 쉼표로 구분된 패키지 이름 목록입니다.	끝점에서 구성된 서비스 클래스 목록입니다.
`runAsFilter`	필터로 기능 실행	false
`scan`	OpenAPI 설명서 생성+	true
`scanAllResources`	비 주석 처리된 JAX-RS 리소스를 포함한 모든 리소스를 스캔합니다( `ignoreRoutes` 옵션 참조)++	false
`schemes`	프로토콜 체계 +	null
`openapiUiConfig`	OpenAPI UI 구성	null
`termsOfServiceUrl`	서비스 URL 추가	null
`title`	제목 +	"sample REST 애플리케이션"
`usePathBasedConfig`	OpenAPI가 `basePath` 옵션의 값을 캐싱하지 못하도록 합니다.	false
`version`	version+	"1.0.0"

+ 옵션은 OpenAPIs BeanConfig에 정의되어 있습니다.

++ 옵션은 OpenAPI의 ReaderConfig에 정의되어 있습니다.