Guia de início rápido: criar sua central de API - CLI do Azure

Artigo
07/04/2024

Crie seu centro de APIs para iniciar um inventário das APIs da sua organização. A Central de APIs do Azure permite o rastreamento de APIs em um local centralizado para descoberta, reutilização e governança.

Depois de criar seu centro de APIs, siga as etapas nos tutoriais para adicionar metadados personalizados, APIs, versões, definições e outras informações.

Pré-requisitos

Se você não tiver uma assinatura do Azure, crie uma conta gratuita do Azure antes de começar.
Pelo menos uma atribuição de função de Colaborador ou permissões equivalentes na assinatura do Azure.

Para a CLI do Azure:
- Use o ambiente Bash no Azure Cloud Shell. Para obter mais informações, consulte Guia de início rápido para Bash no Azure Cloud Shell.
- Se preferir executar comandos de referência da CLI localmente, instale a CLI do Azure. Se estiver a utilizar o Windows ou macOS, considere executar a CLI do Azure num contentor Docker. Para obter mais informações, consulte Como executar a CLI do Azure em um contêiner do Docker.
  - Se estiver a utilizar uma instalação local, inicie sessão no CLI do Azure ao utilizar o comando az login. Para concluir o processo de autenticação, siga os passos apresentados no seu terminal. Para outras opções de entrada, consulte Entrar com a CLI do Azure.
  - Quando solicitado, instale a extensão da CLI do Azure na primeira utilização. Para obter mais informações sobre as extensões, veja Utilizar extensões com o CLI do Azure.
  - Execute o comando az version para localizar a versão e as bibliotecas dependentes instaladas. Para atualizar para a versão mais recente, execute o comando az upgrade.
Nota

az apic comandos exigem a extensão da CLI do apic-extension Azure. Se você não tiver usado az apic comandos, a extensão pode ser instalada dinamicamente quando você executa seu primeiro az apic comando, ou você pode instalar a extensão manualmente. Saiba mais sobre as extensões da CLI do Azure.

Consulte as notas de versão para obter as alterações e atualizações mais recentes no apic-extension.

Registrar o provedor Microsoft.ApiCenter

Se ainda não o fez, tem de registar o fornecedor de recursos Microsoft.ApiCenter na sua subscrição. Você só precisa registrar o provedor de recursos uma vez.

Para registrar o provedor de recursos em sua assinatura usando a CLI do Azure, execute o seguinte az provider register comando:

az provider register --namespace Microsoft.ApiCenter

Você pode verificar o status do registro executando o seguinte az provider show comando:

az provider show --namespace Microsoft.ApiCenter

Criar um grupo de recursos

As instâncias do Centro de API do Azure, como todos os recursos do Azure, devem ser implantadas em um grupo de recursos. Os grupos de recursos permitem organizar e gerenciar recursos relacionados do Azure.

Crie um grupo de recursos usando o az group create comando. O exemplo a seguir cria um grupo chamado MyGroup no local Leste dos EUA :

az group create --name MyGroup --location eastus

Criar um centro de API

Crie um centro de API usando o az apic create comando.

O exemplo a seguir cria um centro de API chamado MyApiCenter no grupo de recursos MyGroup . Neste exemplo, o centro de API é implantado no local da Europa Ocidental. Substitua um nome de centro de API de sua escolha e insira um dos locais disponíveis para seu centro de API.

az apic create --name MyApiCenter --resource-group MyGroup --location westeurope

A saída do comando é semelhante à seguinte. Por padrão, o centro de API é criado no plano Gratuito.

{
  "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"
}

Após a implantação, seu centro de API está pronto para uso!

Próximos passos

Agora você pode começar a adicionar informações ao inventário em seu centro de API. Para ajudá-lo a organizar suas APIs e outras informações, comece definindo metadados personalizados em seu centro de APIs.

Definir metadados personalizados

Partilhar via