Tutorial: Criar ou vincular um Centro de API ao Gerenciamento de API

Este tutorial mostra como integrar (ligar) uma instância de Gestão de APIs Azure com um Centro de APIs Azure. Quando vinculadas, as APIs da instância de Gerenciamento de API — e as definições de API opcionais — são continuamente sincronizadas no inventário do Centro de APIs. O Centro de API é um catálogo central e um hub de governança para APIs e artefatos relacionados, e os clientes do Gerenciamento de API o usam para descobrir e reutilizar APIs, compartilhar definições entre equipes e aplicar políticas consistentes de governança e ciclo de vida.

Observação

Apenas um Centro de API pode ser vinculado a uma única instância de Gerenciamento de API.

Observação

O API Center Standard pode agora ser usado sem custos adicionais quando o liga a uma instância de Gestão de API no nível Standard, Standard v2, Premium ou Premium v2. Para mais informações, consulte planos e funcionalidades do API Center.

Neste tutorial, você:

  • Criar um novo Centro de API e vinculá-lo a uma instância de Gerenciamento de API
  • Vincular um Centro de API existente e sincronizar APIs
  • Visualize APIs sincronizadas e remova o link, se necessário

Pré-requisitos

Antes de começar, certifique-se de que cumpre os seguintes requisitos.

  • É necessária uma conta do Azure com uma subscrição ativa. Se ainda não tiver uma, pode criar uma conta gratuitamente.
  • Um serviço de Gerenciamento de API existente na assinatura onde você deseja gerenciar APIs
  • Permissões de Colaborador (ou Proprietário) no recurso Gerenciamento de API e permissão para criar recursos em um grupo de recursos

Estas etapas mostram como criar uma nova Central de APIs e vinculá-la a uma instância de Gerenciamento de API para que as APIs sejam sincronizadas.

  1. No portal do Azure, abra seu serviço de Gerenciamento de API.

  2. No menu à esquerda, vá para APIs>API Center. A instância de Gerenciamento de API no portal do Azure com a Central de APIs enfatizada no menu à esquerda.

  3. No painel central, em Usar o Centro de API para descoberta, reutilização e governança de API, selecione Criar novo.

  4. Na página Criar Central de APIs , selecione Criar novo link.

  5. Forneça valores para os seguintes campos.

    Campo Detalhes
    Grupo de recursos Selecione um grupo de recursos existente ou crie um novo.
    Localização Escolha uma região. As regiões disponíveis para o Centro de API podem diferir da região da sua instância de Gerenciamento de API.
    Nome Forneça um nome exclusivo para a instância do Centro de APIs.
    Plano de preços Selecione um plano.
    Ciclo de vida Selecione o estado do ciclo de vida a ser associado às APIs quando elas estiverem sincronizadas. Esses metadados podem ser alterados posteriormente.

  6. Selecione Criar.

    • Quando a operação terminar, você verá uma mensagem Solicitação bem-sucedida e uma confirmação de que o serviço de Gerenciamento de API e o Centro de API estão sincronizados.

Usar um Centro de API existente

Estas etapas mostram como vincular uma instância de Gerenciamento de API a uma Central de APIs que já existe.

  1. Na seção Centro de API do seu serviço de Gerenciamento de API, selecione Usar Central de API existente.
  2. Na lista suspensa, escolha o Centro de API que deseja vincular.
  3. Selecione Sincronizar APIs para iniciar a sincronização entre o serviço de Gerenciamento de API e a Central de APIs selecionada.

Exibir o Centro de APIs vinculado e APIs sincronizadas

Use esta seção para verificar o estado de integração e exibir APIs sincronizadas a partir do Gerenciamento de API.

  1. No portal Azure, aceda ao recurso API Center.
  2. No menu lateral do API Center, vá a Plataformas>Integrações. O estado para a integração com o Gerenciamento de API deve dizer Vinculado e sincronização.
  3. Para visualizar APIs sincronizadas, vá a Inventory>Assets.
    Um ícone é exibido indicando que as APIs estão vinculadas. Captura de ecrã mostrando uma instância do Centro de API no portal Azure com os Assets destacados no menu da barra lateral e ícones de ligação destacados no painel principal

Siga estas etapas para remover o link entre o Gerenciamento de API e a Central de APIs ou para excluir o recurso da Central de APIs.

  1. No recurso do API Center, vá a Plataformas>Integrações.
  2. Encontre a instância de Gestão de API ligada.
  3. Selecione o ícone da lixeira para excluir o link.

Limpeza de recursos

Exclua todos os recursos criados para este tutorial para evitar incorrer em cobranças.

Se você criou uma Central de API para este tutorial e não precisa mais dela, exclua o recurso da Central de API e qualquer grupo de recursos criado para evitar cobranças.

Conteúdo relacionado

Sincronizar APIs de uma instância de Gerenciamento de API

  • Last updated on