发现 API 端点

您可以使用 API 安全性查看在您的组织中发现的 API 终端节点。NetScaler 控制台根据在 NetScaler 实例和 API 部署上收到的 API 流量发现 API 端点。

在 NetScaler 控制台中,安全 > API 安全 > API 发现页面显示发现的 API 端点。

  • 虚拟服务器 - 虚拟服务器选项卡显示来自您的 NetScaler 实例的虚拟服务器。虚拟服务器在指定时间段内收到 API 请求时,它们将显示在此选项卡中。

  • API 部署 - 此选项卡显示使用 API 定义从 NetScaler 控制台部署的 API 部署。此选项卡将在 API 部署在指定期间内收到 API 请求时发现 API 端点。要添加和部署 API 定义,请参阅添加 API 定义部署 API 定义

注意:

  • 确保在虚拟服务器上配置分析并启用 Web Insights。请参阅在 API 实例上启用 Web Insight

  • 您只能将策略添加到 API 部署选项卡下发现的 API 端点。

查看 API 端点

API 发现中,当您选择虚拟服务器或 API 部署时,NetScaler 控制台 GUI 会显示 API 端点及其详细信息,例如:

  • 方法 -它显示 API 端点中使用的方法。例如, GETPOST 方法。

  • 请求总数 - 它显示 API 端点上的 API 请求计数。

  • 响应状态 -它显示每个响应状态的计数。例如,2xx3xx4xx5xx

  • 在规范中找到 -此列仅适用于 API 部署。有时,不属于 API 定义的内部 API 可能会接收来自外部的流量。此列可帮助您确定 API 端点和观察方法是否属于 API 定义的一部分。

虚拟服务器中的 API 端点可用如下:

虚拟服务器中的 API 端点

API 部署中的 API 端点可用如下:

虚拟服务器中的 API 端点

您还可以选择所需的 API 端点以查看其详细的分析报告。

详细的 API 终端节点报告

有关每个部分的更多信息,请参阅 查看 API 分析

从发现的 API 端点创建 API 定义

要从发现的 API 端点(API 资源和方法)创建 API 定义,请执行以下操作:

  1. 导航到安全性 > API 安全性 > API 发现,查看虚拟服务器和 API 部署列表。

  2. 在“虚拟服务器”选项卡中单击任意虚拟服务器

  3. 虚拟服务器页面显示已发现的端点列表。选择任意端点,然后单击“创建 API 定义”。

更新 API 定义

注意:

如果您未选择任何端点并单击“创建 API 定义”,则会出现一个弹出窗口,供您确认是否要为所有端点创建 API 定义。单击“”以创建包含所有端点的 API 定义,否则单击“”。

为所有端点弹出消息

  1. 创建 API 定义中,指定以下内容:

    • 名称 -API 定义的名称。

    • API 定义 -定义必须包括标题、版本、基本路径和主机。您可以在 机字段中指定域名或 IP 地址。

    • API 资源 -向定义中添加多个 API 资源。每个资源都有一个路径和支持的方法。

  2. 单击“创建定义”创建 API 定义。

注意:

如果要在将 API 资源路径添加到 API 定义之前对其进行编辑,请在 API 定义屏幕上使用 API 资源的排序或搜索功能。

例如,假设一个名为“/api/products/123-3243-2344334/reviews”的 API 资源,其中路径段“123-3243-2344334”是一个可变的产品 ID。您现在可以对 API 资源进行排序,将资源路径添加为“/api/products/{id}/reviews”,并删除所有 ID 为“/api/products/123-3243-2344334/reviews”的 API 终端节点。

创建 API 定义

使用发现的 API 端点更新现有 API 定义

要使用 API 端点(API 资源和方法)更新现有 API 定义,请执行以下操作:

  1. 导航到安全性 > API 安全性 > API 发现,查看虚拟服务器和 API 部署列表。

  2. 在“虚拟服务器”选项卡中单击任意虚拟服务器

  3. 虚拟服务器页面显示已发现的端点列表。选择要添加到现有 API 定义的终端节点。单击“更新现有 API 定义”。

    更新 API 定义

  4. 从“选择现有 API 定义”下拉列表中,选择要更新的 API 定义。单击“更新定义”。

  5. 将出现“更新现有 API 定义”页面。 API 资源 部分显示以下表格:
    • 已添加资源 -您选择的 API 端点

    • 现有资源 -API 定义中已提供的 API 端点

    注意:

    如果在“已添加的资源”和“现有资源**”中存在相同的 API 端点,则该端点只会添加一次 API 定义中。

  6. 单击“更新定义”。
发现 API 端点