Tutorial: Simular respostas de API

APLICA-SE A: todas as camadas do Gerenciamento de API

As APIs de back-end são importadas para uma API de Gerenciamento de API do Azure ou criadas e gerenciadas manualmente. As etapas neste tutorial descrevem como:

• Use o Gerenciamento de API para criar uma API HTTP em branco.
• Gerencie manualmente uma API HTTP.
• Defina uma política em uma API para que ela retorne uma resposta simulada.

Esse método permite que os desenvolvedores continuem com a implementação e o teste da instância de Gerenciamento de API, mesmo que o back-end não esteja disponível para enviar respostas reais.

Dica

As equipes de API podem usar esse recurso nos workspaces. Os workspaces fornecem acesso administrativo isolado às APIs e aos respectivos ambientes de runtime de API.

A capacidade de criar respostas simuladas é útil em muitos cenários:

• Quando a fachada da API é projetada primeiro e a implementação de back-end ocorre mais tarde ou quando o back-end está sendo desenvolvido em paralelo.
• Quando o back-end está temporariamente inoperante ou não pode ser dimensionado.

Neste tutorial, você aprenderá como:

• Criar uma API de teste
• Adicionar uma operação à API de teste
• Habilitar simulação de resposta
• Testar a API simulada

Pré-requisitos

• Aprenda a terminologia do Gerenciamento de API.
• Entenda o conceito de políticas no Gerenciamento de API.
• Conclua o início rápido Criar uma instância do Gerenciamento de API do Azure.

Criar uma API de teste

As etapas nesta seção mostram como criar uma API HTTP sem back-end.

1. Entre no portal do Azure e navegue até a sua instância do Gerenciamento de API.

2. Selecione o bloco APIs>+ Adicionar API>HTTP:

   

3. Na janela Criar uma API HTTP, selecione Completo.

4. Em Nome de exibição, insira a API de Teste.

5. Em Produtos, selecione Ilimitado, se esse valor estiver disponível. Esse valor só está disponível em algumas camadas. Você pode deixar o valor em branco para este tutorial, mas precisa associar a API a um produto para publicá-lo. Para obter mais informações, consulte Importar e publicar sua primeira API.

6. Em Gateways, selecione Gerenciado se essa opção estiver disponível. (Essa opção só pode ser aproveitada em determinadas camadas de serviço.)

7. Selecione Criar.

   

Adicionar uma operação à API de teste

Uma API expõe uma ou mais operações. Nesta seção, você adicionará uma operação à API HTTP criada. Chamar a operação depois de concluir as etapas nesta seção dispara um erro. Depois de concluir as etapas na seção Habilitar simulação de resposta, você não verá um erro.

Portal

1. Selecione a API que você criou na etapa anterior.

2. Selecione + Adicionar Operação.

3. Na janela Front-end , insira os seguintes valores:

   Configuração	Valor	DESCRIÇÃO
   Nome de exibição	Chamada de teste	O nome exibido no portal do desenvolvedor.
   URL (primeira caixa)	OBTER	Selecione um dos verbos HTTP predefinidos.
   URL (segunda caixa)	/test	Um caminho de URL para a API.
   Descrição		Uma descrição opcional da operação. Ele fornece documentação no portal do desenvolvedor para os desenvolvedores que usam a API.

   

4. Selecione a guia Respostas, que está localizada nas caixasURL, Nome de exibição e Descrição . Você inserirá valores nessa guia para definir códigos de status de resposta, tipos de conteúdo, exemplos e esquemas.

5. Selecione + Adicionar resposta e selecione 200 OK na lista.

   

6. Na seção Representações , selecione + Adicionar representação.

7. Insira application/json na caixa de pesquisa e selecione o tipo de conteúdo de aplicativo/json .

8. Na caixa Exemplo , insira { "sampleField" : "test" }.

9. Clique em Salvar.

   

Embora não seja necessário para este exemplo, você pode definir mais configurações para uma operação de API em outras guias, conforme descrito na tabela a seguir:

Guia	DESCRIÇÃO
Consulta	Adicione os parâmetros de consulta. Além de fornecer um nome e uma descrição, você pode fornecer valores que são atribuídos a um parâmetro de consulta. Você pode marcar um dos valores como padrão (opcional).
Solicitação	Defina esquemas, exemplos e tipos de conteúdo de solicitação.

CLI do Azure

Para começar a usar a CLI do Azure:

• Use o ambiente Bash no Azure Cloud Shell. Para obter mais informações, confira Introdução ao Azure Cloud Shell.

  

• Se preferir executar os comandos de referência da CLI localmente, instale a CLI do Azure. Para execuções no Windows ou no macOS, considere executar a CLI do Azure em um contêiner do Docker. Para obter mais informações, confira Como executar a CLI do Azure em um contêiner do Docker.

  • Se estiver usando uma instalação local, entre com a CLI do Azure usando o comando az login. Para concluir o processo de autenticação, siga as etapas exibidas no terminal. Para obter outras opções de entrada, consulte Autenticar no Azure usando a CLI do Azure.

  • Quando solicitado, instale a extensão da CLI do Azure no primeiro uso. Para obter mais informações sobre extensões, confira Usar e gerenciar extensões com a CLI do Azure.

  • Execute az version para localizar a versão e as bibliotecas dependentes que estão instaladas. Para fazer a atualização para a versão mais recente, execute az upgrade.

Para adicionar uma operação à API de teste, execute o comando az apim api operation create:

az apim api operation create --resource-group <resource-group> \
    --display-name "Test call" --api-id test-api --method GET \
    --url-template /test --service-name <API-management-service-name> 

Execute o comando az apim api operation list para ver todas as operações de uma API:

az apim api operation list --resource-group <resource-group-name> \
    --api-id test-api --service-name <API-management-service-name> --output table

Mantenha essa operação para uso no restante deste artigo. Se você quiser remover uma operação, poderá usar o comando az apim api operation delete . Obtenha a ID da operação do comando anterior.

az apim api operation delete --resource-group <resource-group-name> \
    --api-id test-api --operation-id <ID> \
    --service-name <API-management-service-name>

Habilitar simulação de resposta

1. Selecione a API criada em Criar uma API de teste.

2. Verifique se a guia Design está selecionada.

3. Selecione a operação de teste que você adicionou.

4. Na seção Processamento de entrada, selecione + Adicionar política.

   

5. Selecione o bloco de respostas simuladas da galeria:

   

6. Verifique se 200 OK, application/json aparece na caixa de resposta do gerenciamento de API. Essa seleção indica que sua API deve retornar o exemplo de resposta que você definiu na seção anterior.

   

7. Clique em Salvar.

   Dica

   Uma barra amarela exibindo o texto A simulação está habilitada aparece. Essa mensagem indica que as respostas retornadas do Gerenciamento de API são simuladas pela política de simulação e não são produzidas pelo back-end.

Testar a API simulada

1. Selecione a API criada em Criar uma API de teste.

2. Na guia Teste , verifique se a API de chamada de teste está selecionada e selecione Enviar para fazer uma chamada de teste:

   

3. A resposta HTTP exibe o JSON fornecido como um exemplo na primeira seção do tutorial:

   

Próxima etapa

Vá para o próximo tutorial:

Transformar e proteger uma API publicada