54장. OpenAPI 지원을 사용하여 JAX-RS 끝점 확장
초록
CXF OpenApiFeature(org.apache.cxf.jaxrs.openapi.OpenApiFeature
)를 사용하면 간단한 구성으로 게시된 JAX-RS 서비스 끝점을 확장하여 OpenAPI 문서를 생성할 수 있습니다.
OpenApiFeature는 Spring Boot 및 Karaf 구현 모두에서 지원됩니다.
54.1. OpenApiFeature 옵션
OpenApiFeature에서 다음 옵션을 사용할 수 있습니다.
이름 | 설명 | 기본값 |
---|---|---|
|
컨텍스트 루트 경로 + ( | null |
| 연락처 정보 + | |
| 설명 + | "애플리케이션" |
| 보안 필터 + | null |
| 호스트 및 포트 정보 + | null |
|
모든 리소스를 스캔할 때 특정 경로 제외 ( | null |
| 라이센스 + | "Apache 2.0 라이센스" |
| 라이센스 URL+ | |
|
| false |
| 리소스를 검색해야 하는 쉼표로 구분된 패키지 이름 목록입니다. | 끝점에서 구성된 서비스 클래스 목록입니다. |
| 필터로 기능 실행 | false |
| OpenAPI 설명서 생성+ | true |
|
비 주석 처리된 JAX-RS 리소스를 포함한 모든 리소스를 스캔합니다( | false |
| 프로토콜 체계 + | null |
| OpenAPI UI 구성 | null |
| 서비스 URL 추가 | null |
| 제목 + | "sample REST 애플리케이션" |
|
OpenAPI가 | false |
| version+ | "1.0.0" |
+ 옵션은 OpenAPIs BeanConfig에 정의되어 있습니다.
++ 옵션은 OpenAPI의 ReaderConfig에 정의되어 있습니다.