54장. OpenAPI 지원을 사용하여 Cryostat-RS 끝점 확장
초록
CXF OpenApiFeature(org.apache.cxf.jaxrs.openapi.OpenApiFeature)를 사용하면 간단한 구성으로 게시된 Cryostat-RS 서비스 끝점을 확장하여 OpenAPI 문서를 생성할 수 있습니다.
OpenApiFeature는 Spring Boot 및 Karaf 구현 모두에서 지원됩니다.
54.1. OpenApiFeature 옵션
OpenApiFeature에서 다음 옵션을 사용할 수 있습니다.
| 이름 | 설명 | 기본 |
|---|---|---|
|
| OpenAPI 구성 위치 | null |
|
| 연락처 이메일+ | null |
|
| 연락처 이름+ | null |
|
| 연락처 링크+ | null |
|
| customizer 클래스 인스턴스 | null |
|
| description+ | null |
|
| 보안 필터++ | null |
|
|
모든 리소스를 스캔할 때 특정 경로를 제외합니다( | null |
|
| 라이센스+ | null |
|
| 라이센스 URL+ | null |
|
| openapi.json을 생성할 때 JSON 문서 ++를 완전히 인쇄합니다. | true |
|
| 속성 파일 위치 |
|
|
| @Operation++ 없이 모든 작업도 읽습니다. | true |
|
| ++을 검사해야 하는 리소스 클래스 목록입니다. | null |
|
| 리소스를 스캔해야 하는 패키지 이름 목록 | null |
|
| 기능을 필터로 실행 | false |
|
| 모든 Cryostat-RS 리소스를 자동으로 스캔 | true |
|
| 알려진 OpenAPI 구성 위치(classpath 또는 filesystem)를 스캔합니다. openapi-configuration.yaml openapi-configuration.json openapi.yaml openapi.json | true |
|
| 애플리케이션, 리소스 패키지, 리소스 클래스 및 클래스 경로 스캔의 범위를 지정하는 데 사용되는 Cryostat-RS API 스캐너 클래스의 이름, 리소스 검사 섹션을 참조하십시오. | null |
|
| 보안 정의 목록+ | null |
|
| SwaggerUI 지원 켜기/오프 | null(== true) |
|
| Swagger UI 구성 | null |
|
| SwaggerUI를 고정하기 위한 Maven 아티팩트 | null |
|
| SwaggerUI의 버전 | null |
|
| 서비스 URL+의 용어 | null |
|
| 제목+ | null |
|
| 설정된 경우 각 OpenApiContext 인스턴스에 대해 고유한 컨텍스트 ID가 생성될 것입니다( 여러 서버 끝점 사용을참조하십시오). 또한 scan 속성을 false로 설정할 수 있습니다. | false |
|
| version+ | null |
+ 옵션은 OpenAPI 클래스에 정의되어 있습니다.
++ 옵션은 SwaggerConfiguration 클래스에서 정의됩니다.
