第 1 章 OpenAPI 规格简介
在 Red Hat 3scale API Management 中，OpenAPI 规格(OAS)可帮助您优化管理 OpenAPI 文档。OpenAPI 规格(OAS)为您提供更新现有服务或创建新服务的工具。
以下是 3scale 中 OAS 的特殊注意事项：
- 您还可以使用 3scale toolbox 导入 OpenAPI 规格（OpenAPI 文档）。请参阅 导入 OpenAPI 定义。
- 关于 OAS 3.0，3scale 2.8 引入了更改。详情请参考 第 2.1 节 “3scale API 管理的 OpenAPI 规格 3.0 使用”。
先决条件
- 定义 API 的 OpenAPI 文档。
-
3scale 2.14 实例租户的凭据（
token或provider_key）。
使用 OAS 时，3scale 中提供了以下功能：
注意
当您导入 OpenAPI 文档时，您可以创建或更新 ActiveDocs。请参阅 如何编写 OpenAPI 文档以用作 3scale 规格。
-
将 3scale 服务
system_name作为参数传递，该参数默认为 OAS 中的 info.title 字段。 为 OpenAPI 规格中定义的每个操作创建方法。
-
Method 名称取自
operation.operationId字段。
-
Method 名称取自
在导入新的 API 定义前，所有现有的映射规则都会被删除。
- 如果方法在运行命令之前存在，则不会删除它们。
- 映射为 OpenAPI 规格中定义的每个操作创建规则。
以下频道之一提供 OpenAPI 定义资源：
- 可用路径中的文件名。
- URL 格式 - toolbox 将尝试从指定地址下载。
- 从 stdin 标准输入流读取.
1.1. 在 3scale API 管理中导入 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