5.8. 从 OpenAPI 定义中导入 3scale 后端
您可以使用 import
命令导入 OpenAPI 定义并创建 3scale 后端 API。命令行选项 --backend
可启用此功能。3scale 使用 OpenAPI 定义来创建和存储后端及其专用基础 URL,以及映射规则和方法。
前提条件
- 具有 3scale 2.13 On-Premises 实例的管理员特权的用户帐户。
- 定义 API 的 OAS 文档。
流程
使用以下格式运行
import
命令来创建后端:$ 3scale import openapi -d <remote> --backend <OAS>
-
将
<remote>
替换为用于创建后端的 3scale 实例的 URL。使用此格式:http[s]://<authentication>@3scale_domain
将
<OAS>
替换为/path/to/your/oasdoc.yaml
。表 5.1. 其他 OpenAPI 定义选项 选项 描述 -o --output=<value>
输出格式。可以是 JSON 或 YAML。
--override-private-base-url=<value>
3scale 从 OpenAPI 定义的
servers[0].url
字段读取后端的专用端点。要覆盖该字段中的设置,请指定这个选项,将<value>
替换为您选择的私有基本 URL。当 OpenAPI 定义没有在servers[0].url
字段中指定值,并且您没有在import
命令中指定这个选项,执行会失败。--prefix-matching
在从 OpenAPI 操作派生的映射规则时,使用前缀匹配而不是严格匹配。
--skip-openapi-validation
跳过 OpenAPI 模式验证。
-t --target_system_name=<value>
目标系统名称是您租户中的唯一键。系统名称可以从 OpenAPI 定义中推断出来,但您可以使用这个参数覆盖您自己的名称。