Início Rápido: criar seu centro de API – CLI do Azure

Artigo
07/07/2024

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

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

Pré-requisitos

Caso você não tenha uma assinatura do Azure, crie uma conta gratuita do Azure antes de começar.
Pelo menos uma atribuição da função 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, confira Início Rápido para Bash no Azure Cloud Shell.
- Se preferir executar os comandos de referência da CLI localmente, instale a CLI do Azure. Para execuções no Windows ou no macOS, considere executar a CLI do Azure em um contêiner do Docker. Para obter mais informações, confira Como executar a CLI do Azure em um contêiner do Docker.
  - Se estiver usando uma instalação local, entre com a CLI do Azure usando o comando az login. Para concluir o processo de autenticação, siga as etapas exibidas no terminal. Para ver outras opções de entrada, confira Conectar-se com a CLI do Azure.
  - Quando solicitado, instale a extensão da CLI do Azure no primeiro uso. Para obter mais informações sobre extensões, confira Usar extensões com a CLI do Azure.
  - Execute az version para localizar a versão e as bibliotecas dependentes que estão instaladas. Para fazer a atualização para a versão mais recente, execute az upgrade.
Observação

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

Confira as notas sobre a versão para ver as últimas alterações e atualizações no apic-extension.

Registre o provedor Microsoft.ApiCenter

Caso ainda não tenha feito isso, você precisará registrar o provedor de recursos Microsoft.ApiCenter em sua assinatura. Só será necessário registrar o provedor de recursos uma vez.

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

az provider register --namespace Microsoft.ApiCenter

Verifique o status do registro executando o seguinte comando az provider show:

az provider show --namespace Microsoft.ApiCenter

Criar um grupo de recursos

Instâncias do Centro de API do Azure, assim como todos os recursos do Azure, precisam ser implantadas em um grupo de recursos. Os grupos de recursos permitem que você organize e gerencie os recursos relacionados ao Azure.

Crie um grupo de recursos usando o comando az group create. 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 comando az apic create.

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 Oeste da Europa. Substitua um nome de centro de API de sua escolha e insira um dos locais disponíveis para o 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 API center estará pronto para ser usado!

Próximas etapas

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

Definir metadados personalizados

Compartilhar via