创建或上载 API 定义
API 定义是使用 OpenAPI 规范标准(Swagger 2.0、OpenAPI 3.0.x)描述 API 的文档。此定义可以包含 API 资源路径和操作它们的方法。您可以将 API 定义添加到 NetScaler 控制台,然后将其部署到 API 网关(NetScaler)。
您可以通过以下方式之一创建 API 定义:
注意:
目前,NetScaler 控制台支持解析 使用 Swagger 2.0 或openapi 3.0.1** 的 OAS 规范文件。
上载 OAS 规范
您可以将 OAS 规范上载到 NetScaler 控制台 GUI。
-
导航到“安全性”>“API 安全性”>“API 定义”。
-
单击添加。
-
选择 上载 OAS 规范。
注意:
确保 OAS 规范文件采用 YAML 或 JSON 格式。而且,此文件不得包含外部引用。目前,NetScaler 控制台支持 Swagger 版本 2.0。
-
在本地电脑上浏览 OAS 规范,然后上载到 NetScaler 控制台。
创建 API 定义
您可以在 NetScaler 控制台 GUI 中创建自己的 API 定义。
-
导航到“安全性”>“API 安全性”>“API 定义”。
-
单击添加。
-
选择 创建定义 并指定以下内容:
-
名称 -API 定义的名称。
-
API 定义 -定义必须包括标题、版本、基本路径和主机。您可以在 主 机字段中指定域名或 IP 地址。
-
API 资源 -向定义中添加多个 API 资源。每个资源都有一个路径和支持的方法。单击添加。该资源将添加到“已 添加的资源”表中。单击“删除”删除 API 资源。
-
-
单击创建。
查看 API 定义
“API 定义”页面列出了上载的定义。单击“查看”可查看 以下 API 定义的详细信息:
-
名称 -显示 API 定义的名称。
-
API 定义 -显示定义的标题、版本、基本路径和主机。
-
API 资源 — 列出 API 定义中的 API 资源及其操作方法。