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 informações de inventário e produtos.

Aqui, você importa sua API Web que expõe um ponto de extremidade do OpenAPI. Em seguida, você testará a API importada usando a visualização. Por fim, publique a API.

Observação

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 da NorthWind Shoes para um gateway do Gerenciamento de API.

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

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

  3. Em Criar com base na definição, selecione OpenAPI. O painel Criar com base na especificação OpenAPI é exibido.

    Adicionar uma nova API.

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

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

    Observação

    Você observará que, inserindo 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 painel apim-NorthwindShoesNNNN | 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 usando dois testes. Primeiro, você emitirá uma solicitação GET básica passando um único parâmetro.

  1. No painel apim-NorthwindShoesNNNN | APIs, selecione a API do produto da NorthWindShoes e selecione a guia Teste.

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

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

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

  4. Role para baixo e observe que a URL de solicitação inclui o sufixo /api/Products/{productid}.

  5. Selecione Enviar.

    Você deve receber uma resposta 200 OK à solicitação GET, bem como detalhes da ID de produto inserida.

    Agora, teste usando uma solicitação GET básica sem parâmetros.

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

    Painel de teste com a terceira solicitação GET.

  7. Role para baixo e observe que a URL de solicitação inclui o sufixo /api/Inventory.

  8. Selecione Enviar.

    Você deve receber uma resposta 200 OK à solicitação GET, bem como detalhes do inventário (nível de estoque) de todos os produtos no conteúdo.