通过

导入 OData API

  • 项目

适用于：所有 API 管理层级

本文介绍如何在 API 管理中将符合 OData 标准的服务导入为 API。

在本文中，学习如何：

  • 使用 Azure 门户导入 OData 元数据说明
  • 在门户中管理 OData 架构
  • 保护 OData API

先决条件

  • API 管理实例。 如果你还没有 API 管理服务实例，请完成以下快速入门：创建 Azure API 管理实例。

  • 公开为 OData v2 或 v4 的服务。

转到你的 API 管理实例

  1. 在 Azure 门户中搜索并选择“API 管理服务” 。

    选择“API 管理服务”

  2. 在“API 管理”服务页上，选择你的 API 管理实例。

    选择你的 API 管理实例

导入 OData 元数据

  1. 在左侧菜单中，选择“API”>“+ 添加 API”。

  2. 在“根据定义创建”下，选择“OData”。

    从门户中的 OpenAPI 说明 API 的屏幕截图。

  3. 输入 API 设置。 稍后可以转到 API 的“设置”选项卡来更新设置。

    1. 在 OData 规范中，输入 OData 元数据终结点的 URL，通常是服务根的 URL，并附加 /$metadata。 或者，选择要导入的本地 OData XML 文件。

    2. 输入其余设置以配置 API。 在导入和发布第一个 API 教程中对这些设置进行了说明。

  4. 选择“创建”。

    API 将添加到 API 列表中。 OData 元数据说明中公开的实体集和函数显示在 API 的“架构”选项卡上。

    门户中 OData API 架构的屏幕截图。

更新 OData 架构

可以在门户中访问编辑器以查看 API 的 OData 架构。 如果 API 发生更改，还可以从文件或 OData 服务终结点更新 API 管理中的架构。

  1. 在门户中导航到 API 管理实例。

  2. 在左侧菜单中，选择 OData API 的“API”>。

  3. 在“架构”选项卡上，选择“编辑 (</>)”图标。

  4. 查看架构。 如果要更新它，请选择“从文件更新”或“从终结点更新架构”。

    门户中 OData API 架构编辑器的屏幕截图。

保护 OData API

通过应用现有访问控制策略和 OData 验证策略来保护 OData API，以防止通过 OData API 请求的攻击。

提示

在门户中，在“API 策略”选项卡上为 OData API 配置策略。

追加其他 API

可以为不同服务公开的 API 撰写 API，包括：

  • OpenAPI 规范
  • SOAP API
  • Azure 应用服务中托管的 Web 应用
  • Azure 函数应用
  • Azure 逻辑应用
  • Azure Service Fabric

按照以下步骤将其他 API 追加到现有 API。

注意

导入另一个 API 时，操作将追加到当前 API 后面。

  1. 在 Azure 门户中转到自己的 Azure API 管理实例。

    转到 Azure API 管理实例

  2. 在概述页面上或左侧的菜单上选择“API” 。

    选择“API”

  3. 单击要将另一个 API 追加到的 API 旁边的“...”。

  4. 从下拉菜单中选择“导入”。

    选择“导入”

  5. 选择要从中导入 API 的服务。

    选择服务