Compartilhar via

Tutorial: adicionar ambientes e implantações para APIs

  • Artigo

Aumente o estoque 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 (um endereço) em que os usuários podem acessar uma API.

Para obter informações básicas sobre APIs, implantações e outras entidades que você pode inventariar no Centro de API do Azure, consulte Conceitos chave.

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

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. Você configurará os metadados internos e os metadados personalizados definidos em um tutorial anterior.

  1. No portal, navegue até seu centro de API.

  2. No menu à esquerda, em Ativos, selecione Ambientes>+ Novo ambiente.

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

    Configuração Valor Descrição
    Título do ambiente Insira Meus Testes. O nome que você escolher 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. O tipo de ambiente para APIs.
    Descrição Insira uma descrição opcionalmente. Descrição do ambiente.
    Servidor
    Tipo Opcionalmente, selecione Gerenciamento de API do Azure na lista suspensa. Tipo de solução de gerenciamento de API utilizada.
    URL do portal de gerenciamento Opcionalmente, insira um URL para uma interface de gerenciamento, como https://admin.contoso.com URL da interface de gerenciamento do ambiente.
    Integração
    URL do portal de desenvolvimento Opcionalmente, insira um URL para um portal do desenvolvedor, como https://developer.contoso.com URL da interface para integração do desenvolvedor no ambiente.
    Instruções Opcionalmente, selecione Edit e insira as instruções da 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.

    Captura de tela da adição de um ambiente de API no portal.

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

Adicionar uma implantação

O Centro de API também pode ajudar você a catalogar suas implantações de API, ou seja, os ambientes de runtime nos quais as APIs que você acompanha são implantadas.

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

  1. No portal, navegue até seu centro de API.

  2. No menu à esquerda, 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. Caso definiu anteriormente os metadados personalizados de Linha de negócios ou outros metadados atribuídos a ambientes, você as visualizará na parte inferior da página.

    Configuração Valor Descrição
    Título Insira Implantação V1. O nome que você escolher 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 Insira uma descrição opcionalmente. Descrição da implantação.
    Ambiente Faça uma seleção na lista suspensa, como Meu teste, ou selecione Criar. Um ambiente novo ou existente no qual 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 do runtime básico para a API no 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 as APIs no ambiente.

    Captura de tela da adição de uma implantação de API no portal.

  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