1장. OpenAPI 사양 소개


Red Hat 3scale API Management에서 OAS(OpenAPI Specification)를 사용하면 OpenAPI 문서를 최적으로 관리할 수 있습니다. OAS(OpenAPI Specification)는 기존 서비스를 업데이트하거나 새 서비스를 생성하는 도구를 제공합니다.

다음은 3scale의 OAS에 대한 특별한 고려 사항입니다.

사전 요구 사항

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

OAS를 사용하면 3scale에서 다음 기능을 사용할 수 있습니다.

참고

OpenAPI 문서를 가져올 때 ActiveDocs를 만들거나 업데이트합니다. 3scale 사양으로 사용할 OpenAPI 문서를 작성하는 방법을 참조하십시오.

  • 3scale 서비스 system_name 을 OAS의 info.title 필드로 설정하는 선택적 매개변수로 전달하는 기능
  • OpenAPI 사양에 정의된 각 작업에 대해 메서드가 생성됩니다.

    • 메서드 이름은 operation.operationId 필드에서 가져옵니다.
  • 기존 매핑 규칙은 새 API 정의를 가져오기 전에 삭제됩니다.

    • 명령을 실행하기 전에 존재하는 경우 메서드가 삭제되지 않습니다.
  • OpenAPI 사양에 정의된 각 작업에 대해 매핑 규칙이 생성됩니다.
  • 다음 채널 중 하나에서 OpenAPI 정의 리소스를 제공합니다.

    • 사용 가능한 경로의 파일 이름
    • URL 형식 - toolbox는 지정된 주소에서 다운로드하려고 합니다.
    • stdin 표준 입력 스트림에서 읽습니다.

1.1. OpenAPI 문서를 3scale로 가져오기 위한 명령행 옵션

3scale CLI(명령줄 인터페이스)는 3scale로 관리할 API를 정의하는 OpenAPI 문서를 가져오는 몇 가지 옵션을 제공합니다. 다음은 openapi 옵션에 대한 도움말 정보입니다.

NAME
    openapi - Import API definition in OpenAPI specification

USAGE
    3scale import openapi [opts] -d <dst> <spec>

DESCRIPTION
    Using an API definition format like OpenAPI, import to your 3scale API

OPTIONS
       -d --destination=<value>                   3scale target instance.
                                                  Format: "http[s]://<authentication>@3scale_domain"

 -t --target_system_name=<value>            Target system name

OPTIONS FOR IMPORT
    -c --config-file=<value>                      3scale toolbox
                                                  configuration file
                                                  (default:
                                                  $HOME/.3scalerc.yaml)
    -h --help                                     show help for this command
    -k --insecure                                 Proceed and operate even
                                                  for server connections
                                                  otherwise considered
                                                  insecure
    -v --version                                  Prints the version of this
                                                  command
Red Hat logoGithubredditYoutubeTwitter

자세한 정보

평가판, 구매 및 판매

커뮤니티

Red Hat 문서 정보

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

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

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

Red Hat 소개

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

Theme

© 2026 Red Hat
맨 위로 이동