你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
适用于:所有 API 管理层级
本文介绍如何手动将 API 添加到 Azure API 管理。 若要从 API 创建模拟响应,可以创建空白 API。 有关创建模拟 API 响应的信息,请参阅 模拟 API 响应。
如果要导入现有 API,请参阅本文的 “相关内容 ”部分。
本文介绍如何创建空白 API。 你将 httpbin.org (公共测试服务)指定为后端 API。
先决条件
- 完成创建 Azure API 管理实例快速入门。
转到你的 API 管理实例
在 Azure 门户中,搜索并选择“API 管理服务”:
在“API 管理服务”页上,选择你的 API 管理实例:
创建 API
在左侧菜单中的 API 下,选择 API。
选择“+ 添加 API”。
选择 HTTP 图块:
输入 API 的后端“Web 服务 URL”(例如 )和其他设置。 在导入和发布第一个 API 教程中对这些设置进行了说明。
选择“创建” 。
此时,API 管理中没有任何操作映射到后端 API 中的操作。 如果调用通过后端公开但未通过 API 管理公开的操作,则会出现 404 错误。
注意
默认情况下,添加 API 时,即使它已连接到后端服务,API 管理也不会公开任何操作,直到你允许它们为止。 若要允许后端服务的某个操作,请创建一个映射到后端操作的 API 管理操作。
添加并测试操作
本部分介绍如何添加/get
操作以将其映射到后端http://httpbin.org/get
操作。
添加操作
- 选择上一步中创建的 API。
- 选择 “+ 添加操作”。
- 在 URL 中,选择 GET 并在文本框中输入 /get 。
- 在 “显示名称”中,输入 FetchData。
- 选择“保存” 。
测试操作
在 Azure 门户中测试操作。 (还可以在开发人员门户中对其进行测试。
- 选择“测试”选项卡。
- 选择“FetchData”。
- 选择发送。
由http://httpbin.org/get
生成的响应将显示在HTTP 响应部分中。 若要转换操作,请参阅转换和保护 API。
添加并测试参数化操作
本部分介绍如何添加一个采用参数的操作。 在此示例中,将操作映射到 http://httpbin.org/status/200
。
添加操作
- 选择之前创建的 API。
- 在“设计”选项卡中,选择“+ 添加操作” 。
- 在 URL 中,选择 GET 并在文本框中输入 /status/{code} 。
- 在 “显示名称”中,输入 GetStatus。
- 选择“保存” 。
测试操作
在 Azure 门户中测试操作。 (还可以在开发人员门户中对其进行测试。
选择“测试”选项卡。
选择“GetStatus”。 在 代码中,输入 200。
选择发送。
该操作生成的响应将显示在HTTP响应部分中。 若要转换操作,请参阅转换和保护 API。
添加和测试通配符操作
此部分显示如何添加通配符操作。 通过通配符操作,您可以使用 API 请求传递任意值。 可创建一个通配符 GET 操作,而不是像前述几部分所示创建单独的 GET 操作。
注意
配置通配符操作时要谨慎。 此配置可能会使 API 更容易受到某些 API 安全威胁的影响。
添加操作
- 选择之前创建的 API。
- 在“设计”选项卡中,选择“+ 添加操作” 。
- 在 URL 中,选择 GET 并在文本框中输入 /* 。
- 在 显示名称 中,输入 WildcardGet。
- 选择“保存” 。
测试操作
在 Azure 门户中测试操作。 (还可以在开发人员门户中对其进行测试。
选择“测试”选项卡。
选择“WildcardGet”。 尝试在前述部分中已经测试过的 GET 操作,或者尝试其他受支持的 GET 操作。
例如,在 模板参数中,将通配符 \ 名称旁边的值更改为 标头。 该操作会返回传入请求的 HTTP 标头。
选择发送。
http://httpbin.org/headers
操作生成的响应将显示在 HTTP 响应 部分中。 若要转换操作,请参阅转换和保护 API。
注意
了解要集成的后端 API 的主机如何处理操作 URL 上的尾部斜杠,这一点很重要。 有关详细信息,请参阅此 API 管理常见问题解答。
追加其他 API
可以通过不同服务公开的 API 撰写 API,包括:
- OpenAPI 规范
- SOAP API
- GraphQL API
- Azure 应用服务中托管的 Web 应用
- Azure Functions(Azure 功能服务)
- Azure 逻辑应用
- Azure Service Fabric
注意
导入一个 API 时,操作会追加到当前 API。
将 API 追加到现有 API:
在 Azure 门户中转到你的 Azure API 管理实例:
在“概述”页上选择“API”,或在左侧菜单中选择“API”“API”>。
选择要将另一个 API 追加到的 API 旁边的省略号 (...)。
从下拉菜单中选择“导入”:
选择要从中导入 API 的服务。