Exercício – importar e publicar uma API

  • 5 minutos

Agora que seu gateway está configurado, você está pronto para importar e publicar uma API para que os parceiros possam acessar o inventário e as informações do produto.

Aqui, você importa sua API da Web que expõe um ponto de extremidade OpenAPI. Em seguida, você testa a API importada usando a visualização. Finalmente, você publica a API.

Nota

Este exercício usa os recursos que você configurou no exercício anterior.

Importar a API

A primeira parte do exercício é importar a API NorthWind Shoes para um gateway de Gerenciamento de API.

  1. No menu de recursos do portal do Azure ou na página inicial , selecione Todos os Recursos e selecione seu serviço de Gerenciamento de API.

  2. No menu Serviço de Gerenciamento de API, em APIs, selecione APIs e + Adicionar API.

  3. Em Criar a partir da definição, selecione OpenAPI. O painel de especificações Criar a partir da OpenAPI é exibido.

    Adicione uma nova API.

  4. Na janela de especificação OpenAPI, conclua as seguintes configurações:

    Definição Value
    Especificação de OpenAPI Cole o URL JSON do Swagger que você salvou do exercício anterior.
    Nome a apresentar Aceite o padrão, que deve ser NorthWindShoes Products.
    Nome Aceite o padrão, que deve ser northwindshoes-products.
    Sufixo do URL de API Ignore essa configuração.
    URL Base Aceite o padrão.

    Nota

    Você notará que, ao inserir a URL JSON, vários outros campos são preenchidos automaticamente para você. Isso ocorre porque usamos OpenAPI, que especifica todos os detalhes de conexão necessários.

  5. Selecione Criar. O apim-NorthwindShoesNNNN | O painel APIs exibe todas as operações para a API de produtos NorthWindShoes.

Visualizar a API

A última parte do exercício é testar a API e visualizar os resultados com dois testes. Primeiro, emita uma solicitação GET básica, passando um único parâmetro.

  1. No apim-NorthwindShoesNNNN | Painel APIs, selecione a API do produto NorthWindShoes e, em seguida, selecione a guia Teste.

  2. Selecione a primeira operação GET, Encontre os detalhes do produto especificado. Os detalhes aparecem no console de teste.

  3. Em Parâmetros do modelo, insira um valor numérico para o parâmetro ID do produto.

    Painel de teste com o valor de ID do produto realçado.

  4. Desloque-se para baixo e repare que o URL do Pedido inclui o sufixo /api/Products/{productid}.

  5. Selecione Enviar.

    Você deve obter uma resposta 200 OK para a solicitação GET e detalhes sobre o ID do produto que você inseriu.

    Agora, faça um teste com um pedido GET básico sem parâmetros.

  6. Selecione a terceira operação GET, Recuperar todo o inventário de produtos da empresa e verifique se a guia Teste está selecionada.

    Painel de teste com terceira solicitação GET.

  7. Desloque-se para baixo e repare que o URL do Pedido inclui o sufixo /api/Inventory.

  8. Selecione Enviar.

    Você deve obter uma resposta de 200 OK para a solicitação GET e detalhes do estoque (nível de estoque) para todos os produtos na carga útil.