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

第 1 章 OpenAPI 规范简介

在红帽 3scale API 管理中，OpenAPI 规范(OAS)可帮助您优化管理 OpenAPI 文档。OpenAPI 规范(OAS)为您提供了更新现有服务或创建新服务的工具。

以下是 3scale 中 OAS 的特别考虑事项：

先决条件

  • 定义您的 API 的 OpenAPI 文档。
  • 3scale 2.11 实例租户的凭据（令牌 或 provider_key）。

使用 OAS 时，3scale 中提供了以下功能：

注意

导入 OpenAPI 文档时，您可以创建或更新 ActiveDocs。请参阅 如何编写 OpenAPI 文档以用作 3scale 规范。

  • 可以将 3scale 服务 system_name 作为可选参数传递，默认为 OAS 中的 info.title 字段。

  • 针对 OpenAPI 规范中定义的每个操作创建方法。

    • 从 operation.operationId 字段中获取 方法 名称。

  • 在导入新的 API 定义前，所有现有 的映射规则 都会被删除。

    • 如果方法存在，则不会删除它们，然后再运行 命令。
  • 为 OpenAPI 规范中定义的每个操作创建规则。

  • 以下频道之一提供 OpenAPI 定义资源：

    • 可用路径 中的文件名
    • URL 格式 - toolbox 将尝试从给定地址下载。
    • 从 stdin 标准输入流读取.

1.1. 3scale 中导入 OpenAPI 文档的命令行选项
复制链接

3scale 命令行界面(CLI)提供多个选项，用于导入 OpenAPI 文档，它们定义了您要在 3scale 中管理的 API。以下是 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
Copy to Clipboard Toggle word wrap
返回顶部
Red Hat logoGithubredditYoutubeTwitter

学习

尝试、购买和销售

社区

关于红帽文档

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

让开源更具包容性

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

關於紅帽

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

Theme

© 2025 Red Hat