练习 - 创建后端 API
本练习介绍如何执行以下操作:
- 创建 API 管理 (APIM) 实例
- 导入 API
- 配置后端设置
- 测试 API
先决条件
- 具有活动订阅的 Azure 帐户。 如果你还没有,可在 https://azure.com/free 注册免费试用版。
登录 Azure
登录到 Azure 门户,并打开 Cloud Shell。
在 shell 打开之后,请务必选择“Bash”环境。
创建 API 管理实例
我们为 CLI 命令设置一些变量,以减少重复键入的次数。 将
<myLocation>
替换为对你有意义的区域。 APIM 名称必须是全局唯一的名称,且以下脚本将生成一个随机字符串。 将<myEmail>
替换为你可以访问的电子邮件地址。myApiName=az204-apim-$RANDOM myLocation=<myLocation> myEmail=<myEmail>
创建资源组。 以下命令将创建一个名为 az204-apim-rg 的资源组。
az group create --name az204-apim-rg --location $myLocation
创建 APIM 实例。
az apim create
命令用于创建实例。--sku-name Consumption
选项用于加快演练过程。az apim create -n $myApiName \ --location $myLocation \ --publisher-email $myEmail \ --resource-group az204-apim-rg \ --publisher-name AZ204-APIM-Exercise \ --sku-name Consumption
备注
此操作应在大约五分钟内完成。
导入后端 API
本部分演示如何导入和发布 OpenAPI 规范后端 API。
在 Azure 门户中搜索并选择“API 管理服务” 。
在“API 管理”屏幕上,选择你创建的 API 管理实例。
在“API 管理服务”导航窗格中,选择“API”。
从列表中选择“OpenAPI”,然后在弹出窗口中选择“完全”。
使用下表中的值填写表单。 你可以将任何未提及的字段保留其默认值。
设置 值 说明 OpenAPI 规范 https://conferenceapi.azurewebsites.net?format=json
引用实现 API 的服务,将请求转发到此地址。 输入此信息后,将自动填充表单中的大部分必要信息。 显示名称 演示会议 API 此名称显示在开发人员门户中。 名称 demo-conference-api 提供 API 的唯一名称。 说明 自动填充 提供 API 的可选说明。 API URL 后缀 会议 此后缀附加到 API 管理服务的基础 URL。 API 管理通过其后缀区分 API,因此后缀对给定发布者上的每个 API 必须唯一。 选择“创建” 。
配置后端设置
演示会议 API 已创建,需要指定后端。
在右侧边栏选项卡中选择“设置”,然后在“Web 服务 URL”字段中输入
https://conferenceapi.azurewebsites.net/
。取消选择“需要订阅”复选框。
选择“保存”。
测试 API
导入 API 并配置后端后,就可以测试 API 了。
选择“测试”。
选择“GetSpeakers”。 页面中会显示“查询参数”和“标头”(如果有)。 为与此 API 关联的订阅密钥自动填充
Ocp-Apim-Subscription-Key
。选择Send。
后端以“200 正常”和某些数据做出响应 。
清理 Azure 资源
完成本练习中创建的资源后,可以使用下面的命令删除资源组和所有相关资源。
az group delete --name az204-apim-rg