Tutorial: adicionar ambientes e implantações para APIs

Este tutorial explica como aumentar o inventário em seu centro de API adicionando informações sobre ambientes e implantações de API.

• Um ambiente representa um local em que um runtime de API pode ser implantado, por exemplo, uma plataforma de gerenciamento de API.
• Uma implantação é um local ou endereço onde os usuários podem acessar uma API.

Para obter mais informações sobre APIs, implantações e outras entidades que você pode inventariar no Centro de API do Azure, consulte os principais conceitos.

Neste tutorial, você aprenderá a usar o portal para:

• Adicionar informações sobre ambientes de API
• Adicionar informações sobre implantações de API

Pré-requisitos

• Um centro de API na sua assinatura do Azure. Para criar um, consulte Início Rápido: Criar seu centro de API.
• Uma ou mais APIs registradas no centro de API. Se você não tiver nenhuma APIs registrada, consulte Tutorial: Registrar APIs em seu inventário de API. Esse tutorial usa as APIs de exemplo que você adicionou do tutorial anterior.

Adicionar um ambiente

Use seu Centro de API para acompanhar seus ambientes de API do mundo real. Por exemplo, você pode usar o Gerenciamento de API do Azure ou outra solução para distribuir, proteger e monitorar algumas das suas APIs. Ou você pode atender diretamente a algumas APIs usando um serviço de computação ou um cluster do Kubernetes.

Aqui você adiciona informação sobre um ambiente fictício de Gerenciamento de API ao seu Centro de API. Se preferir, adicione informações sobre um dos seus ambientes existentes. Configure os metadados internos e os metadados personalizados definidos em um tutorial anterior.

1. Entre no portal do Azure e navegue até o centro de API.

2. No menu da barra lateral, em Ativos, selecione Ambientes>+ Novo ambiente.

3. Na página Novo ambiente, adicione as seguintes informações. Se você definiu anteriormente os metadados personalizados da Linha de Negócios ou outros metadados atribuídos a ambientes, você os verá na parte inferior da página.

   Configurações	Value	Description
   Título do ambiente	Insira Meus Testes.	Nome que você escolhe para o ambiente
   Identificação	Após você inserir o título anterior, o Centro de API do Azure gera esse identificador, que pode ser substituído.	Nome do recurso do Azure para o ambiente
   Tipo de ambiente	Selecione Testando na lista suspensa.	Tipo de ambiente para APIs
   Descrição	Se quiser, insira uma descrição.	Descrição do ambiente
   Servidor
   Tipo	Opcionalmente, selecione Gerenciamento de API do Azure na lista suspensa.	Tipo de solução de gerenciamento de API usada
   URL do portal de gerenciamento	Opcionalmente, insira uma URL para uma interface de gerenciamento, como https://admin.contoso.com	URL da interface de gerenciamento para o ambiente
   Integração
   URL do portal de desenvolvimento	Opcionalmente, insira uma URL para um portal do desenvolvedor, como https://developer.contoso.com	URL da interface para integração de desenvolvedores no ambiente
   Instruções	Opcionalmente, selecione Editar e insira instruções de integração no Markdown padrão.	Instruções para integrar as APIs do ambiente
   Linha de negócios	Caso adicionou estes metadados personalizados, opcionalmente faça uma seleção na lista suspensa, como IT.	Metadados personalizados que identificam a unidade de negócios que gerencia o ambiente

   

4. Selecione Criar. O ambiente aparece na lista de ambientes.

Adicionar uma implantação

O centro de API também pode ajudá-lo a catalogar suas implantações de API, os ambientes de runtime em que as APIs que você rastreia são implantadas.

Aqui você adiciona uma implantação associando uma das versões da API ao ambiente criado na seção anterior. Você configura os metadados internos e os metadados personalizados que você definiu.

1. No portal do Azure, navegue até o centro de API.

2. No menu da barra lateral, em Ativos, selecione APIs.

3. Selecione uma API, por exemplo, a API de Conferência.

4. Na página API de Conferência, em Detalhes, selecione Implantações>+ Adicionar implantação.

5. Na página Adicionar implantação, adicione as seguintes informações. Se você definiu anteriormente os metadados personalizados da Linha de Negócios ou outros metadados atribuídos a ambientes, poderá vê-los na parte inferior da página.

   Configurações	Value	Description
   Title	Insira Implantação V1.	Nome que você escolheu para a implantação
   Identificação	Após você inserir o título anterior, o Centro de API do Azure gera esse identificador, que pode ser substituído.	Nome do recurso do Azure para a implantação
   Descrição	Se quiser, insira uma descrição.	Descrição da implantação
   Ambiente	Faça uma seleção na lista suspensa, como Meu teste, ou selecione Criar.	Ambiente novo ou existente em que a versão da API é implantada
   Definição	Selecione ou adicione um arquivo de definição para uma versão da API de Conferência.	Arquivo de definição de API
   URL do Runtime	Insira uma URL base, por exemplo, https://api.contoso.com.	URL básica de execução para a API no ambiente de execução
   Linha de negócios	Caso adicionou estes metadados personalizados, opcionalmente faça uma seleção na lista suspensa, como IT.	Metadados personalizados que identificam a unidade de negócios que gerencia APIs no ambiente

   

6. Selecione Criar. A implantação aparece na lista de implantações.

Neste tutorial, você aprendeu a usar o portal para:

• Adicionar informações sobre ambientes de API
• Adicionar informações sobre implantações de API

Conteúdo relacionado

• Saiba mais sobre o Centro de API do Azure
• Controlar dependências de recursos de API