如何通过 Azure API 管理中的操作导入 API 的定义

在 API 管理中,可以创建新的 API,并手动添加操作,或者 API 可以在单个步骤中与操作一起导入。

API 及其操作可以使用以下格式导入。

  • WADL
  • Swagger

本指南演示如何创建一个新的 API,并在一个步骤中导入其操作。 有关手动创建一个 API 和添加操作的信息,请参阅如何创建 API如何将操作添加到 API

导入 API

API 在发布者门户中进行创建和配置。 若要访问发布者门户,请在 API 管理服务的 Azure 门户中单击“发布者门户”。 如果尚未创建 API 管理服务实例,请参阅 Azure API 管理入门教程中的创建 API 管理服务实例

发布者门户

单击左侧“API 管理”菜单中的“API”,并单击“导入 API”。

导入 API

“导入 API”窗口具有对应于提供 API 规范的三种方法的三个选项卡。

  • “从剪贴板”允许将 API 规范粘贴到指定文本框。
  • “从文件”允许浏览并选择包含 API 规范的文件。
  • “从 URL”允许向 API 的规范提供 URL。

导入 API 格式

提供 API 规范后,使用右侧的单选按钮来指示规范格式。 支持以下格式。

  • WADL
  • Swagger

接下来,输入 Web API URL 后缀。 这会追加到 API 管理服务的基 URL。 基 URL 对 API 管理服务的每个实例上托管的所有 API 很常见。 API 管理通过后缀区分 API,因此对于特定 API 管理服务实例中的每个 API,此后缀必须唯一。

所有值都输入后,单击“保存”创建 API 和关联的操作。

Note

有关以 Swagger 格式导入基本计算器 API 的教程,请参阅在 Azure API 管理中管理第一个 API

导入 API

除了导入新的 API 外,还可以从发布者门户导出 API 的定义。 为此,请单击“API”的“摘要”选项卡中的“导出 API”。

导出 API

可以使用 WADL 或 Swagger 导出 API。 选择所需的格式,请单击“保存”,并选择要在其中保存该文件的位置。

导出 API 格式

后续步骤

API 创建并导入操作后,可以查看和配置任何其他设置,将 API 添加到一种产品并将其发布,这样就可提供给开发人员。 有关详细信息,请参阅以下指南。