2.5. MicroProfile OpenAPI
2.5.1. JBoss EAP의 MicroProfile OpenAPI 링크 복사링크가 클립보드에 복사되었습니다!
MicroProfile OpenAPI는 microprofile-openapi-undercloudrye 하위 시스템을 사용하여 JBoss EAP에 통합됩니다.
MicroProfile OpenAPI 사양은 OpenAPI 3.0 문서를 제공하는 HTTP 끝점을 정의합니다. OpenAPI 3.0 문서는 호스트의 REST 서비스를 설명합니다. OpenAPI 끝점은 배포와 연결된 호스트의 루트에 로컬로 구성된 경로(예: http://localhost:8080/openapi)를 사용하여 등록됩니다. http://localhost:8080/openapi
현재 가상 호스트의 OpenAPI 엔드포인트는 단일 배포만 문서화할 수 있습니다. 동일한 가상 호스트에서 다른 컨텍스트 경로에 등록된 여러 배포와 함께 OpenAPI를 사용하려면 각 배포에서 별도의 엔드포인트 경로를 사용해야 합니다.
OpenAPI 엔드포인트는 기본적으로 YAML 문서를 반환합니다. Accept HTTP 헤더 또는 형식 쿼리 매개변수를 사용하여 JSON 문서를 요청할 수도 있습니다.
지정된 애플리케이션의 Cryostat 서버 또는 호스트가 HTTPS 리스너를 정의하는 경우 HTTPS를 사용하여 OpenAPI 문서도 사용할 수 있습니다. 예를 들어 HTTPS의 끝점은 https://localhost:8443/openapi 입니다.