閱讀英文

共用方式為

手动添加 API

  • 2025/03/18

适用于：所有 API 管理层级

本文介绍如何将 API 手动添加到 API 管理实例。 要模拟 API，可以创建一个空白 API，也可以手动定义它。 有关模拟 API 的详细信息，请参阅模拟 API 响应。

如果要导入现有 API，请参阅 相关内容 部分。

本文将会创建一个空白的 API，并将 httpbin.org（一个公共测试服务）指定为后端 API。

先决条件

请完成以下快速入门：创建一个 Azure API 管理实例

转到你的 API 管理实例

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

    选择“API 管理服务”

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

    选择你的 API 管理实例

创建 API

  1. 在 Azure 门户中导航到 API 管理服务，然后从菜单中选择“API”。
  2. 在左侧菜单中，选择“+ 添加 API”。
  3. 从列表中选择“HTTP”。
    空白 API
  4. 输入 API 的后端“Web 服务 URL”（例如 ）和其他设置。 在导入和发布第一个 API 教程中对这些设置进行了说明。
  5. 选择“创建” 。

此时，API 管理中没有任何操作映射到后端 API 中的操作。 如果调用通过后端（而不是通过 API 管理）公开的操作，则会收到 404 错误。

注意

默认情况下，在添加某个 API 时，除非你允许，否则即使该 API 已连接到某个后端服务，API 管理也不会公开任何操作。 若要允许后端服务的某个操作，请创建一个映射到后端操作的 API 管理操作。

添加并测试操作

本部分介绍如何添加“/get”操作，以将其映射到后端“http://httpbin.org/get"”操作。

添加操作

  1. 选择上一步中创建的 API。
  2. 选择“+ 添加操作”。
  3. 在“URL”中，选择“GET”，并在资源中输入 。
  4. 输入“FetchData”作为“显示名称”。
  5. 选择“保存” 。

测试操作

在 Azure 门户中测试操作。 还可以在开发人员门户中测试。

  1. 选择“测试”选项卡。
  2. 选择“FetchData”。
  3. 按“发送”。

随后将显示 "http://httpbin.org/get" 操作生成的响应。 若要转换操作，请参阅转换和保护 API。

添加并测试参数化操作

本部分介绍如何添加一个采用参数的操作。 在本例中，我们将该操作映射到 "http://httpbin.org/status/200"。

添加操作

  1. 选择上一步中创建的 API。
  2. 选择“+ 添加操作”。
  3. 在“URL”中，选择“GET”，并在资源中输入 。 （可选）可以提供与此参数关联的某些信息。 例如，为“类型”输入“数字”，为“值”输入“200”（默认值）。
  4. 输入“GetStatus”作为“显示名称”。
  5. 选择“保存” 。

测试操作

在 Azure 门户中测试操作。 还可以在开发人员门户中测试。

  1. 选择“测试”选项卡。

  2. 选择“GetStatus”。 默认情况下，代码值设置为“200”。 可以更改默认值以测试其他值。 例如，键入“418”。

  3. 按“发送”。

    随后将显示 "http://httpbin.org/status/200" 操作生成的响应。 若要转换操作，请参阅转换和保护 API。

添加和测试通配符操作

此部分显示如何添加通配符操作。 通过通配符操作可使用 HTTP 请求传递任意值。 可创建一个通配符 GET 操作，而不是像前述几部分所示创建单独的 GET 操作。

警告

在配置通配符操作时，请小心。 此配置可能会使 API 更容易受到某些 API 安全威胁的影响。

添加操作

  1. 选择上一步中创建的 API。
  2. 选择“+ 添加操作”。
  3. 在“URL”中，选择“GET”，并在资源中输入 。
  4. 为显示名称输入“WildcardGet”。
  5. 选择“保存” 。

测试操作

在 Azure 门户中测试操作。 还可以在开发人员门户中测试。

  1. 选择“测试”选项卡。

  2. 选择“WildcardGet”。 尝试在前述部分中已经测试过的 GET 操作，或者尝试其他受支持的 GET 操作。

    例如，在“模板参数”中，将通配符 (*) 名称旁边的值更新为 。 该操作会返回传入请求的 HTTP 标头。

  3. 按“发送”。

    随后将显示 "http://httpbin.org/headers" 操作生成的响应。 若要转换操作，请参阅转换和保护 API。

注意

了解要集成的后端 API 的主机如何处理操作 URL 上的尾部斜杠，这一点很重要。 有关详细信息，请参阅此 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 的服务。

    选择服务