创建或上传 API 定义
API 定义是使用 OpenAPI 规范标准描述 API 的文档。此定义可以包含 API 资源路径和操作这些资源的方法。您可以将 API 定义添加到 NetScaler Console,然后将其部署到 API 网关 (NetScaler)。
您可以通过以下方式之一创建 API 定义:
注意:
目前,NetScaler Console 支持解析使用 Swagger 2.0 或 openapi 3.0.1 的 OAS 规范文件。
上传 OAS 规范
您可以将 OAS 规范上传到 NetScaler Console GUI。
-
导航到“Security(安全)”>“API Security(API 安全)”>“API Definitions(API 定义)”。
-
单击“Add(添加)”。
-
选择“Upload OAS Specification(上传 OAS 规范)”。
注意:
确保 OAS 规范文件为 YAML 或 JSON 格式。此外,此文件不得包含外部引用。
-
从本地计算机浏览 OAS 规范并将其上传到 NetScaler Console。
创建 API 定义
您可以在 NetScaler Console GUI 中创建自己的 API 定义。
-
导航到“Security(安全)”>“API Security(API 安全)”>“API Definitions(API 定义)”。
-
单击“Add(添加)”。
-
选择“Create Your Definition(创建您的定义)”并指定以下内容:
-
Name(名称) - API 定义的名称。
-
API Definition(API 定义) - 定义必须包含标题、版本、基本路径和主机。您可以在“Host(主机)”字段中指定域名或 IP 地址。
-
API Resources(API 资源) - 向您的定义添加多个 API 资源。每个资源都有一个路径和支持的方法。单击“Add(添加)”。该资源将添加到“Added Resources(已添加资源)”表中。单击“Delete(删除)”以删除 API 资源。
-
-
单击“Create(创建)”。
查看 API 定义
“API Definitions(API 定义)”页面列出了已上传的定义。单击“View(查看)”以查看以下 API 定义详细信息:
-
Name(名称) – 显示 API 定义的名称。
-
API Definition(API 定义) – 显示定义的标题、版本、基本路径和主机。
-
API resources(API 资源) – 列出 API 定义中的 API 资源及其操作方法。