Red Hat Summit Red Hat Summit지원콘솔개발자평가판 시작연락처

3.6. MicroProfile OpenAPI 관리

3.6.1. MicroProfile OpenAPI 활성화
링크 복사

microprofile-openapi-undercloudrye 하위 시스템은 standalone-microprofile.xml 구성에 제공됩니다. 그러나 JBoss EAP XP는 기본적으로 standalone.xml 을 사용합니다. 이를 사용하려면 standalone.xml 에 하위 시스템을 포함해야 합니다.

또는 MicroProfile 하위 시스템 및 확장 기능을 사용하여 독립 실행형 구성 업데이트 절차에 따라 standalone.xml 구성 파일을 업데이트할 수 있습니다.

프로세스

  1. JBoss EAP에서 MicroProfile OpenAPI smallrye 확장을 활성화합니다. 

    /extension=org.wildfly.extension.microprofile.openapi-smallrye:add()

  2. 다음 관리 명령을 사용하여 microprofile-openapi-undercloudrye 하위 시스템을 활성화합니다. 

    /subsystem=microprofile-openapi-smallrye:add()

  3. 서버를 다시 로드합니다. 

    reload

microprofile-openapi-Neutronrye 하위 시스템이 활성화됩니다.

3.6.2. Accept HTTP 헤더를 사용하여 MicroProfile OpenAPI 문서 요청
링크 복사

Accept HTTP 헤더를 사용하여 배포에서 MicroProfile OpenAPI 문서를 JSON 형식으로 요청합니다.

기본적으로 OpenAPI 엔드포인트는 YAML 문서를 반환합니다.

사전 요구 사항

  • 쿼리 중인 배포는 MicroProfile OpenAPI 문서를 반환하도록 구성됩니다.

프로세스

  • 다음 curl 명령을 실행하여 배포의 /openapi 엔드포인트를 쿼리합니다. 

    $ curl -v -H'Accept: application/json' http://localhost:8080/openapi
< HTTP/1.1 200 OK
...
{"openapi": "3.0.1" ... }

    http://localhost:8080 를 배포의 URL 및 포트로 교체합니다.

    Accept 헤더는 application/json 문자열을 사용하여 JSON 문서를 반환함을 나타냅니다.

3.6.3. HTTP 매개변수를 사용하여 MicroProfile OpenAPI 문서 요청
링크 복사

HTTP 요청의 쿼리 매개변수를 사용하여 배포에서 MicroProfile OpenAPI 문서를 요청합니다.

기본적으로 OpenAPI 엔드포인트는 YAML 문서를 반환합니다.

사전 요구 사항

  • 쿼리 중인 배포는 MicroProfile OpenAPI 문서를 반환하도록 구성됩니다.

프로세스

  • 다음 curl 명령을 실행하여 배포의 /openapi 엔드포인트를 쿼리합니다. 

    $ curl -v http://localhost:8080/openapi?format=JSON
< HTTP/1.1 200 OK
...

    http://localhost:8080 를 배포의 URL 및 포트로 교체합니다.

    HTTP 매개변수 format=JSON 은 JSON 문서가 반환됨을 나타냅니다.

3.6.4. 정적 OpenAPI 문서를 제공하도록 JBoss EAP 구성
링크 복사

호스트의 REST 서비스를 설명하는 정적 OpenAPI 문서를 제공하도록 JBoss EAP를 구성합니다.

JBoss EAP가 정적 OpenAPI 문서를 제공하도록 구성된 경우 정적 OpenAPI 문서는 Jakarta RESTful Web Services 및 MicroProfile OpenAPI 주석보다 먼저 처리됩니다.

프로덕션 환경에서 정적 문서를 제공할 때 주석 처리를 비활성화합니다. 주석 처리를 비활성화하면 클라이언트에 변경 불가능한 버전이 지정된 API 계약을 사용할 수 있습니다.

프로세스

  1. 애플리케이션 소스 트리에 디렉터리를 생성합니다. 

    $ mkdir APPLICATION_ROOT/src/main/webapp/META-INF

    APPLICATION_ROOT 는 애플리케이션의 pom.xml 구성 파일을 포함하는 디렉터리입니다.

  2. OpenAPI 엔드포인트를 쿼리하여 출력을 파일로 리디렉션합니다. 

    $ curl http://localhost:8080/openapi?format=JSON > src/main/webapp/META-INF/openapi.json

    기본적으로 끝점은 YAML 문서를 제공하며 format=JSON 은 JSON 문서가 반환되도록 지정합니다.

  3. OpenAPI 문서 모델을 처리할 때 주석 스캔을 건너뛰도록 애플리케이션을 구성합니다. 

    $ echo "mp.openapi.scan.disable=true" > APPLICATION_ROOT/src/main/webapp/META-INF/microprofile-config.properties

  4. 애플리케이션을 다시 빌드합니다. 

    $ mvn clean install

  5. 다음 관리 CLI 명령을 사용하여 애플리케이션을 다시 배포합니다.

    1. 애플리케이션 배포를 취소합니다. 

      undeploy microprofile-openapi.war

    2. 애플리케이션을 배포합니다. 

      deploy APPLICATION_ROOT/target/microprofile-openapi.war

JBoss EAP는 이제 OpenAPI 엔드포인트에서 정적 OpenAPI 문서를 제공합니다.

3.6.5. microprofile-openapi-undercloudrye 비활성화
링크 복사

관리 CLI를 사용하여 JBoss EAP XP에서 microprofile-openapi-undercloudrye 하위 시스템을 비활성화할 수 있습니다.

프로세스

  • microprofile-openapi-Neutronrye 하위 시스템을 비활성화합니다. 

    /subsystem=microprofile-openapi-smallrye:remove()
Red Hat logoGithubredditYoutubeTwitter

자세한 정보

평가판, 구매 및 판매

커뮤니티

Red Hat 문서 정보

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

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

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

Red Hat 소개

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

Theme

© 2026 Red Hat맨 위로 이동