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

2장. OpenAPI 사양 구성 방법

OpenAPI 사양이 3scale로 작동하려면 사용할 버전에 맞게 올바르게 구성해야 합니다.

사전 요구 사항

  • API를 정의하는 OpenAPI 문서입니다.
  • 3scale 2.13 인스턴스 테넌트의 인증 정보(token 또는 provider_key).

2.1. 3scale로 OpenAPI Specification 3.0 사용
링크 복사

3scale은 OAS 3.0 사용에 대한 다음과 같은 지원을 제공합니다.

  • OAS 3.0을 지원하기 위해 개발자 포털에서 Swagger -ui 가 업데이트되었습니다.
  • 이제 Swagger-ui 가 웹팩 자산(node_modules)으로 포함됩니다. 이전에는 CDN(Content Delivery Networks)에서 추가되었습니다.
  • 관리 포털에서 새 OAS 3.0 문서는 swagger-ui 에서 제공하는 기능을 사용하여 자동으로 식별되고 처리됩니다. 이 기능에는 개발자 포털의 구성이 필요합니다.

OAS 3.0 사양을 ActiveDocs에 추가하고 다음 점을 고려하여 개발자 포털에 표시할 수 있습니다.

  • 템플릿을 수동으로 업그레이드해야 합니다.
  • ActiveDoc에는 요청을 시도할 때 인증 정보 삽입 및 서비스 이름과 같은 실제 데이터를 사용하여 자동 완성과 같은 추가 기능이 없습니다.

2.1.1. OAS 3.0을 사용하여 개발자 포털 구성
링크 복사

이 스니펫에는 새 버전의 swagger-ui 가 포함되어 있으며 사용 가능한 첫 번째 ActiveDoc을 렌더링합니다. 또한 OAS 2.0을 렌더링하지만 일반적인 ActiveDocs 기능은 표시되지 않습니다.

OAS 3.0 사양을 지원하려면 기본 문서 페이지의 다음 콘텐츠가 필요합니다. 

{% content_for javascripts %}
 {{ 'active_docs.js' | javascript_include_tag }}
{% endcontent_for %}

{% assign spec = provider.api_specs.first %}

<h1>Documentation</h1>

<div class="swagger-section">
 <div id="message-bar" class="swagger-ui-wrap"></div>
 <div id="swagger-ui-container" class="swagger-ui-wrap"></div>
</div>

<script type="text/javascript">
 (function () {
   var url = "{{spec.url}}";
   var serviceEndpoint = "{{spec.api_product_production_public_base_url}}"
   SwaggerUI({ url: url, dom_id: "#swagger-ui-container" }, serviceEndpoint);
 }());
</script>
Copy to Clipboard Toggle word wrap

OAS 3.0으로 개발자 포털 업데이트

3scale 2.8에서 OAS 3.0을 구성하고 OAS 3.0을 계속 사용하려면 템플릿을 업데이트해야 합니다.

이 템플릿은 구성할 템플릿입니다. 

{% content_for javascripts %}
    {{ 'active_docs.js' | javascript_include_tag }}
{% endcontent_for %}

<h1>Documentation</h1>

<div class="swagger-section">
  <div id="message-bar" class="swagger-ui-wrap">&nbsp;</div>
  <div id="swagger-ui-container" class="swagger-ui-wrap"></div>
</div>

<script type="text/javascript">
  (function () {
    var url = "{{provider.api_specs.first.url}}";

    SwaggerUI({ url: url, dom_id: "#swagger-ui-container" });
  }());
</script>
Copy to Clipboard Toggle word wrap

템플릿을 업데이트하려면 기본 문서 페이지를 2.1.1절. “OAS 3.0을 사용하여 개발자 포털 구성” 에 포함된 스니펫로 교체합니다.

Red Hat logoGithubredditYoutubeTwitter

자세한 정보

평가판, 구매 및 판매

커뮤니티

Red Hat 문서 정보

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

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

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

Red Hat 소개

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

Theme

© 2026 Red Hat맨 위로 이동