Tutorial: Respostas simuladas da API

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 (APIM) ou criadas e gerenciadas manualmente. As etapas neste tutorial, mostram como:

• Usar o Gerenciamento de API para criar uma API HTTP em branco
• Gerenciar uma API HTTP manualmente
• Definir 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.

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

• Quando a fachada de API é concebida primeiro e a implementação de back-end é efetuada mais tarde. Quando o back-end está a ser desenvolvido em paralelo.
• Quando o back-end está temporariamente não operacional ou não consegue dimensionar.

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

• Conhecer a terminologia da Gestão de API do Azure.
• Compreender o conceito das políticas da Gestão de API do Azure.
• Conclua o guia de início rápido seguinte: Criar uma instância da Gestão 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é sua instância de Gerenciamento de API.

2. Selecione APIs>+ Adicionar bloco HTTP da API.>

   

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

4. Insira a API de teste para Nome de exibição.

5. Selecione Ilimitado para Produtos.

6. Verifique se Gerenciado está selecionado para Gateways.

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 Ativar simulação de resposta, você não obterá erros.

Portal

1. Selecione a API que criou no passo anterior.

2. Selecione + Adicionar Operação.

3. Na janela Frontend, insira os seguintes valores.

   

   Definição	valor	Description
   Nome a apresentar	Chamada de teste	O nome exibido no portal do desenvolvedor.
   URL (verbo HTTP)	GET	Selecione um dos verbos HTTP predefinidos.
   URL	/test	Um caminho de URL para a API.
   Descrição		Descrição opcional da operação, usada para fornecer documentação no portal do desenvolvedor para os desenvolvedores que usam essa API.

4. Selecione a guia Respostas , localizada nos campos URL, Nome para exibição e Descrição. Insira as configurações nesta 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. No cabeçalho Representações à direita, selecione + Adicionar representação.

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

8. Na caixa de texto Exemplo, introduza { "sampleField" : "test" }.

9. 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, incluindo:

Separador	Description
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.

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, consulte Guia de início rápido para Bash no 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 Entrar com a CLI do Azure.

  • Quando solicitado, instale a extensão da CLI do Azure na primeira utilização. Para obter mais informações sobre as extensões, veja Utilizar extensões com o 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 apim-hello-word-resource-group \
    --display-name "Test call" --api-id test-api --method GET \
    --url-template /test --service-name apim-hello-world 

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

az apim api operation list --resource-group apim-hello-word-resource-group \
    --api-id test-api --service-name apim-hello-world --output table

Para remover uma operação, use o comando az apim api operation delete . Obtenha o ID da operação do comando anterior.

az apim api operation delete --resource-group apim-hello-word-resource-group \
    --api-id test-api --operation-id 00000000000000000000000000000000 \
    --service-name apim-hello-world

Mantenha esta operação para uso no restante deste artigo.

Ativar a simulação de respostas

1. Selecione a API que você criou em Criar uma API de teste.

2. Na janela à direita, verifique se a guia Design está selecionada.

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

4. Na janela Processamento de entrada, selecione + Adicionar política.

   

5. Selecione Respostas fictícias na galeria.

   

6. Na caixa de texto Respostas da Gestão de API, escreva 200 OK, application/json. Esta seleção indica que a API deve devolver o exemplo de resposta que definiu na secção anterior.

   

7. Selecione Guardar.

   Gorjeta

   Uma barra amarela com o texto Mocking está ativada é exibida . Isso indica que as respostas retornadas do Gerenciamento de API são ridicularizadas pela política de simulação e não são produzidas pelo back-end.

Testar a API simulada

1. Selecione a API que você criou em Criar uma API de teste.

2. Selecione o separador Teste.

3. Verifique se a API de chamada de teste está selecionada e, em seguida, selecione Enviar para fazer uma chamada de teste.

   

4. A resposta de HTTP apresenta o JSON fornecido como um exemplo na primeira secção do tutorial.

   

Próximos passos

Neste tutorial, ficou a saber como:

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

Avance para o tutorial seguinte:

Transformar e proteger a sua API