Red Hat Summit 红帽全球峰会支持控制台（Console）开发人员开始试用联系人

此内容没有您所选择的语言版本。

Chapter 1. Creating a new service based on OAS

1.1. Introduction
复制链接

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

1.2. Prerequisites
复制链接

  • OpenAPI Specification (OAS)
  • A 3scale 2.7 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

学习

尝试、购买和销售

社区

关于红帽文档

通过我们的产品和服务，以及可以信赖的内容，帮助红帽用户创新并实现他们的目标。 了解我们当前的更新.

让开源更具包容性

红帽致力于替换我们的代码、文档和 Web 属性中存在问题的语言。欲了解更多详情，请参阅红帽博客.

關於紅帽

我们提供强化的解决方案，使企业能够更轻松地跨平台和环境（从核心数据中心到网络边缘）工作。

Theme

© 2025 Red Hat