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

이 콘텐츠는 선택한 언어로 제공되지 않습니다.

Chapter 1. Creating a new service based on OAS

1.1. Introduction
링크 복사

This documentation outlines the features of OpenAPI Specification (OAS) in Red Hat 3scale API Management 2.9 and provides steps to update an existing service or create a new one.

The following are special considerations about OAS in 3scale:

1.2. Prerequisites
링크 복사

  • OpenAPI Specification (OAS)
  • A 3scale 2.9 instance tenant credentials (token or provider_key)

1.3. Features of OpenAPI Specification
링크 복사

Note

ActiveDocs are created/updated when importing OpenAPI (OAS)

  • Service’s system_name can be passed as an option parameter and defaults to info.title field from OAS.

  • Methods are created for each operation from the OAS.

    • Method names are taken from operation.operationId field.

  • All existing mapping rules are deleted before importing a new API definition.

    • Methods will be not deleted if they exist before running the command.
  • Mapping rules are created on each operation from the OAS.

  • The OpenAPI definition resource can be provided by one of the following channels:

    • Filename in the available path
    • URL format - toolbox will try to download from given address.
    • Read from stdin standard input stream.

1.4. Using OpenAPI Specification
링크 복사

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
Copy to Clipboard Toggle word wrap

1.4.1. Detecting OpenAPI definition from the filename path
링크 복사

The allowed formats are json and yaml. The format is automatically detected from filename extension. 

$ 3scale import openapi -d <destination> /path/to/your/spec/file.[json|yaml|yml]
Copy to Clipboard Toggle word wrap

1.4.2. Detecting OpenAPI definition from a URL
링크 복사

The allowed formats are json and yaml. The format is automatically detected from URL’s path extension. 

$ 3scale import openapi -d <destination> http[s]://domain/resource/path.[json|yaml|yml]
Copy to Clipboard Toggle word wrap

1.4.3. Detecting OpenAPI definition from stdin
링크 복사

The command line parameter for the OpenAPI resource is -.

The allowed formats are json and yaml. The format is automatically detected internally with parsers. 

$ tool_to_read_openapi_from_source | 3scale import openapi -d <destination> -
Copy to Clipboard Toggle word wrap
맨 위로 이동
Red Hat logoGithubredditYoutubeTwitter

자세한 정보

평가판, 구매 및 판매

커뮤니티

Red Hat 문서 정보

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

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

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

Red Hat 소개

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

Theme

© 2025 Red Hat