Exercício – Criar um gateway de API

  • 10 minutos

Neste exercício, você implanta uma API Web de exemplo e configura um gateway de API. Em uma unidade posterior, você publicará a API Web no seu gateway.

No exemplo da empresa de calçados, a NorthWind Shoes decidiu compartilhar uma API de inventário com parceiros. Essa API permite que os parceiros acessem informações sobre o inventário e os produtos.

Importante

É preciso ter uma assinatura do Azure para fazer esse exercício, e isso pode gerar encargos. Caso ainda não tenha uma assinatura do Azure, crie uma conta gratuita antes de começar.

Implantar a API Web ShoeCompany

Você desenvolveu um aplicativo .NET Core que gera informações de inventário e produto. O aplicativo inclui o Swashbuckle para gerar a documentação do Swagger da OpenAPI.

Para economizar tempo, vamos começar executando um script para hospedar nossa API de ResTful no Azure. O script executa as seguintes etapas:

  • Cria um Plano do Serviço de Aplicativo do Azure na Camada gratuita.
  • Cria uma API Web dentro de um Serviço de Aplicativo do Azure, configurada para implantação do Git por meio de um repositório local.
  • Define credenciais de implantação no nível da conta para o nosso aplicativo.
  • Configura o Git localmente.
  • Implanta a nossa API Web na nossa instância do Serviço de Aplicativo.

  1. Entre no portal do Azure.

  2. Na barra de tarefas do Azure, selecione o ícone do Cloud Shell para abrir o Azure Cloud Shell.

    Uma captura de tela do ícone do Cloud Shell na barra de tarefas.

  3. Execute o comando git a seguir no Cloud Shell para clonar o repositório GitHub e baixar o código-fonte do nosso aplicativo.

    git clone https://github.com/MicrosoftDocs/mslearn-publish-manage-apis-with-azure-api-management.git

  4. Após a conclusão da operação, abra a pasta do repositório local e liste seu conteúdo executando os seguintes comandos.

    cd mslearn-publish-manage-apis-with-azure-api-management
ls -l

    Um dos arquivos é setup.sh. Como o nome sugere, é o script que executaremos para configurar a nossa API de teste.

  5. Execute este script inserindo o seguinte comando. Ele gera um aplicativo Web público que expõe uma interface da OpenAPI.

    bash setup.sh

    O script leva cerca de um minuto para ser executado. Durante a implantação, todas as dependências necessárias para execução do nosso aplicativo serão instaladas automaticamente no Serviço de Aplicativo remoto. A saída lista todas as operações. Quando o script for concluído, as duas últimas linhas serão URLs que você usará para testar a implantação do aplicativo.

  6. Para testar se nosso aplicativo foi implantado corretamente, copie a primeira URL (URL do Swagger) de Cloud Shell e cole-a em uma nova guia do navegador.

    O navegador deverá exibir a interface do usuário do Swagger do nosso aplicativo e declarar os seguintes pontos de extremidade RESTful:

    • api/inventory gera uma lista de produtos e o número em estoque.
    • api/inventory/{productid} retorna o número em estoque para a ID de produto especificada (um inteiro).
    • api/Products gera uma lista de produtos.
    • api/Products/{productid} retorna os detalhes para a ID de produto especificada.

    Visão geral do Gerenciamento de API.

  7. Por fim, copie a segunda URL (URL JSON do Swagger) da saída do Cloud Shell e salve-a em algum lugar, como o Bloco de notas. Você precisará dessa URL no próximo exercício.

Implantar um gateway de API

A tarefa final deste exercício é criar um gateway de API no portal do Azure. No próximo exercício, você usará esse gateway para publicar sua API.

  1. Entre no portal do Azure.

  2. Nos Serviços do Azure ou na Página inicial, selecione Criar um recurso. O painel Criar um recurso será exibido.

  3. No menu de recursos, selecione Integração e, na lista de resultados, escolha Gerenciamento de API. Um painel Criar serviço de Gerenciamento de API é exibido.

  4. Na guia Básico, insira os valores a seguir para cada configuração.

    Configuração Valor
    Detalhes do projeto
    Subscription Selecione sua assinatura.
    Resource group Selecione um grupo de recursos novo ou existente. Um grupo de recursos consiste em um contêiner lógico que armazena os recursos relacionados de uma solução do Azure.
    Detalhes da instância
    Região Selecione uma região disponível.
    Nome do Recurso apim-NorthWindShoes<random number>, substituindo random number por sua própria série de números para garantir que o nome seja globalmente exclusivo.
    Nome da Organização NorthWindShoes. O nome de sua organização para uso nas notificações do portal do desenvolvedor e por email. (O portal do desenvolvedor e as notificações não estão disponíveis em todas as camadas de serviço.)
    Email do administrador O endereço de email para receber todas as notificações do sistema.
    Camada de preços Consumption

    Observação

    A camada Consumo fornece implantação rápida para teste e tem um modelo de preço de pagamento por uso. A experiência geral de gerenciamento de API é semelhante a outros tipos de preço.

  5. Selecione Examinar + criar para validar suas configurações.

  6. Depois da aprovação na validação, selecione Criar. A implantação pode levar vários minutos para ser concluída.

  7. Quando a implantação for concluída, sua instância do Gerenciamento de API será listada nos recursos do Azure. Selecione Ir para o recurso a fim de exibir o painel do serviço de Gerenciamento de API.