Tutorial: Respostas simuladas da API

2025-04-09

APLICA-SE A: Todas as camadas de 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.

Gorjeta

As equipes de API podem usar esse recurso em espaços de trabalho. Os espaços de trabalho fornecem acesso administrativo isolado a APIs e aos seus próprios ambientes de execução de API.

A capacidade de criar respostas fictícias é útil em muitos cenários:

Quando a fachada da API é projetada primeiro e a implementação do back-end ocorre mais tarde, ou quando o back-end está sendo desenvolvido em paralelo.
Quando o back-end não está temporariamente operacional ou não é capaz de escalar.

Neste tutorial, irá aprender a:

Criar uma API de teste
Adicionar uma operação à API de teste
Ativar a simulação de respostas
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 de Gerenciamento de API do Azure.

Criar uma API de teste

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

Entre no portal do Azure e navegue até sua instância de Gerenciamento de API.
Selecione APIs>+ Adicionar API>HTTP tile:
Na janela Criar uma API HTTP, selecione Completo.
Em Nome para exibição, insira Test API.
Em Produtos, selecione Ilimitado, se esse valor estiver disponível. Esse valor está disponível apenas 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.
Em Gateways, selecione Gerenciado se essa opção estiver disponível. (Esta opção está disponível apenas em determinadas camadas de serviço.)
Selecione Criar.

Adicionar uma operação à API de teste

Uma API expõe uma ou mais operações. Nesta seção, você adiciona 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 Ativar simulação de resposta , você não receberá um erro.

Portais
CLI do Azure

Selecione a API que você criou na etapa anterior.
Selecione + Adicionar Operação.

Na janela Frontend , 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)	Obtém	Selecione um dos verbos HTTP predefinidos.
URL (segunda caixa)	/teste	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.

Selecione a guia Respostas , localizada nas caixas URL,Nome para exibição e Descrição . Você inserirá valores nesta guia para definir códigos de status de resposta, tipos de conteúdo, exemplos e esquemas.
Selecione + Adicionar resposta e, em seguida, selecione 200 OK na lista.
Na seção Representações , selecione + Adicionar representação.
Digite application/json na caixa de pesquisa e selecione o tipo de conteúdo application/json .
Na caixa Exemplo , digite { "sampleField" : "test" }.
Selecione Guardar.

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 parâmetros de consulta. Além de fornecer um nome e uma descrição, você também pode fornecer valores atribuídos a um parâmetro de consulta. Você pode marcar um dos valores como padrão (opcional).
Pedir	Defina tipos de conteúdo, exemplos e esquemas de solicitação.

Para começar a usar a CLI do Azure:

Use o ambiente Bash no Azure Cloud Shell. Para obter mais informações, consulte Introdução ao Azure Cloud Shell.
Se preferir executar comandos de referência da CLI localmente, instale a CLI do Azure. Se estiver a utilizar o Windows ou macOS, considere executar a CLI do Azure num contentor Docker. Para obter mais informações, consulte Como executar a CLI do Azure em um contêiner do Docker.
- Se estiver a utilizar uma instalação local, inicie sessão no CLI do Azure ao utilizar o comando az login. Para concluir o processo de autenticação, siga os passos apresentados no seu terminal. Para outras opções de entrada, consulte Autenticar no Azure usando a CLI do Azure.
- Quando solicitado, instale a extensão da CLI do Azure na primeira utilização. Para obter mais informações sobre extensões, consulte Usar e gerenciar extensões com a CLI do Azure.
- Execute o comando az version para localizar a versão e as bibliotecas dependentes instaladas. Para atualizar para a versão mais recente, execute o comando az upgrade.

Para adicionar uma operação à sua 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>

Para ver todas as suas operações para uma API, execute o comando az apim api operation list:

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

Mantenha esta operação para uso no resto deste artigo. Se você quiser remover uma operação, você pode usar o comando az apim api operation delete . Obtenha o 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>

Ativar a simulação de respostas

Selecione a API que você criou em Criar uma API de teste.
Verifique se a guia Design está selecionada.
Selecione a operação de teste que adicionou.
Na seção Processamento de Entrada, selecione + adicionar política.
Selecione o bloco Respostas fictícias na galeria:
Certifique-se de que 200 OK, application/json apareça 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.
Selecione Guardar.

Gorjeta

Uma barra amarela exibindo o texto Simulação está ativada é exibida. 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

Selecione a API que você criou em Criar uma API de teste.
Na guia Teste , verifique se a API de chamada de teste está selecionada e selecione Enviar para fazer uma chamada de teste:
A resposta HTTP exibe o JSON fornecido como um exemplo na primeira seção do tutorial:

Próximo passo

Vá para o próximo tutorial:

Transformar e proteger uma API publicada