5.2. 개발자 포털에서 ActiveDocs 게시

사전 요구 사항

• REST API의 OAS(OpenAPI Specification) 호환 사양은 개발자 포털의 ActiveDocs의 전원을 켜야 합니다.

절차

• 개발자 포털의 모든 페이지에 다음 스니펫을 추가합니다. 이 작업은 3scale 관리 포털을 통해 수행해야 합니다.

  참고

  SERVICE_NAME 은 서비스 사양의 시스템 이름이어야 하며, 이 이름은 example의 Pet_store 입니다.

  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 2.0을 사용한 개발자 포털 구성

  <h1>Documentation</h1>
  <p>Use our live documentation to learn about Echo API</p>
  {% active_docs version: "2.0" services: "SERVICE_NAME" %}
  {% cdn_asset /swagger-ui/2.2.10/swagger-ui.js %} {% cdn_asset /swagger-ui/2.2.10/swagger-ui.css %} {% include 'shared/swagger_ui' %}
  <script type="text/javascript">
    $(function () {
      {% comment %}
        // you have access to swaggerUi.options object to customize its behavior
        // such as setting a different docExpansion mode
        window.swaggerUi.options['docExpansion'] = 'none';
        // or even getting the swagger specification loaded from a different url
        window.swaggerUi.options['url'] = "http://petstore.swagger.io/v2/swagger.json";
      {% endcomment %}
      window.swaggerUi.load();
    });
  </script>

  Copy to Clipboard Toggle word wrap

• 한 페이지에 하나의 서비스만 지정할 수 있습니다. 여러 사양을 표시하려면 가장 좋은 방법은 다른 페이지에서 수행하는 것입니다.
• 이 스니펫에는 개발자 포털의 기본 레이아웃에 기본적으로 포함된Query가 필요합니다. 기본 레이아웃에서Query 종속성을 제거하는 경우 ActiveDocs가 포함된 페이지에 이 종속성을 추가해야 합니다.
• 관리 포털에서 Liquid 태그가 활성화되어 있는지 확인합니다.
• OAS 2.0 {{ '{% active_docs version: "2.0" ' }}%} 의 리쿼드 태그에서 사용되는 버전은 Swagger 사양과 일치해야 합니다.