你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
快速入门:创建 API 中心 - Azure CLI
创建 API 中心以启动组织的 API 清单。 Azure API 中心支持在一个集中位置跟踪 API,以便进行发现、重用和治理。
创建 API 中心后,请按照教程中的步骤添加自定义元数据、API、版本、定义和其他信息。
先决条件
如果没有 Azure 订阅,请在开始之前创建一个 Azure 免费帐户。
在 Azure 订阅中至少分配有参与者角色或等效权限。
对于 Azure CLI:
在 Azure Cloud Shell 中使用 Bash 环境。 有关详细信息,请参阅 Azure Cloud Shell 中的 Bash 快速入门。
如需在本地运行 CLI 参考命令,请安装 Azure CLI。 如果在 Windows 或 macOS 上运行,请考虑在 Docker 容器中运行 Azure CLI。 有关详细信息,请参阅如何在 Docker 容器中运行 Azure CLI。
如果使用的是本地安装,请使用 az login 命令登录到 Azure CLI。 若要完成身份验证过程,请遵循终端中显示的步骤。 有关其他登录选项,请参阅使用 Azure CLI 登录。
出现提示时,请在首次使用时安装 Azure CLI 扩展。 有关扩展详细信息,请参阅使用 Azure CLI 的扩展。
运行 az version 以查找安装的版本和依赖库。 若要升级到最新版本,请运行 az upgrade。
注意
az apic
命令需要 Azure CLI 扩展apic-extension
。 如果尚未使用az apic
命令,则可以在运行第一个az apic
命令时动态安装扩展,也可以手动安装扩展。 详细了解 Azure CLI 扩展。请参阅最新更改的发行说明和
apic-extension
中的更新。
注册 Microsoft.ApiCenter 提供程序
如果尚未注册,则需要在订阅中注册 Microsoft.ApiCenter 资源提供程序。 只需注册资源提供程序一次。
要在订阅中使用 Azure CLI 注册资源提供程序,请运行以下 az provider register
命令:
az provider register --namespace Microsoft.ApiCenter
你可以通过运行以下 az provider show
命令来检查注册状态。
az provider show --namespace Microsoft.ApiCenter
创建资源组
Azure API 中心实例(例如所有 Azure 资源)都必须部署到资源组中。 使用资源组可以组织和管理相关的 Azure 资源。
使用 az group create
命令创建资源组。 以下示例在“美国东部”位置创建名为“MyGroup”的组。
az group create --name MyGroup --location eastus
创建 API 中心
使用 az apic create
命令创建 API 中心。
以下示例在 MyGroup 资源组中创建名为 MyApiCenter 的 API 中心。 在此示例中,API 中心部署在“西欧”位置。 替换所选的 API 中心名称,并输入 API 中心的其中一个可用位置。
az apic create --name MyApiCenter --resource-group MyGroup --location westeurope
命令的输出与以下所示相似。 默认情况下,API 中心是在免费计划中创建的。
{
"dataApiHostname": "myapicenter.data.westeurope.azure-apicenter.ms",
"id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/mygroup/providers/Microsoft.ApiCenter/services/myapicenter",
"location": "westeurope",
"name": "myapicenter",
"resourceGroup": "mygroup",
"sku": {
"name": "Free"
},
"systemData": {
"createdAt": "2024-06-22T21:40:35.2541624Z",
"lastModifiedAt": "2024-06-22T21:40:35.2541624Z"
},
"tags": {},
"type": "Microsoft.ApiCenter/services"
}
部署后,API 中心可供你使用!
后续步骤
现在可以开始将信息添加到 API 中心的清单。 为了帮助整理 API 和其他信息,请首先在 API 中心定义自定义元数据。