Compartilhar via


Tutorial: Simular respostas de API

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

As APIs de back-end são importadas para um APIM (Gerenciamento de API) 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 do 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 da API é criada primeiro e a implementação do back-end ocorre posteriormente. Ou, o back-end está sendo desenvolvido paralelamente.
  • Quando o back-end temporariamente não está operacional ou não pode ser escalado.

Neste tutorial, você aprenderá como:

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

Resposta de API fictícia

Pré-requisitos

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>API.

    Definir uma API do HTTP

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

  4. Insira API de Teste como Nome de exibição.

  5. Insira Ilimitado para Produtos.

  6. Verifique se Gerenciado está selecionado em Gateways.

  7. Selecione Criar.

    Criar uma API do HTTP

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 que criou. Chamar a operação depois de concluir as etapas nesta seção dispara um erro. Você não receberá erros após concluir as etapas na seção Habilitar a simulação de resposta.

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

  2. Selecione + Adicionar Operação.

  3. Na janela Front-end, insira os valores a seguir.

    Janela de front-end

    Configuração Valor DESCRIÇÃO
    Nome de exibição 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 a documentação no portal do desenvolvedor para os desenvolvedores que usarão a API.
  4. Selecione a guia Respostas, localizada sob os campos URL, Nome de exibição e Descrição. Insira as configurações nessa guia para definir os códigos de status de resposta, os tipos de conteúdo, os exemplos e os esquemas.

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

    Adicionar resposta à operação da API

  6. Sob o cabeçalho Representações à direita, selecione + Adicionar representação.

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

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

  9. Clique em Salvar.

    Adicionar representação à operação da API

Embora não seja necessário para este exemplo, você pode definir configurações adicionais de uma operação de API em outras guias, incluindo:

Tab 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.

Habilitar a simulação de resposta

  1. Selecione a API criada 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 você adicionou.

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

    Adicionar política de processamento

  5. Selecione Respostas fictícias da galeria.

    Bloco de política de respostas fictícias

  6. Na caixa de texto Resposta de Gerenciamento de API, digite 200 OK, application/json. Essa seleção indica que a sua API deve retornar o exemplo de resposta definido na seção anterior.

    Definir resposta fictícia

  7. Clique em Salvar.

    Dica

    Uma barra amarela com o texto Simulação habilitada é exibida. Isso 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 fictícia

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

  2. Selecione a guia Testar.

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

    Testar a API fictícia

  4. A Resposta HTTP exibe o JSON fornecido como um exemplo na primeira seção desse tutorial.

    Resposta HTTP fictícia

Próximas etapas

Neste tutorial, você aprendeu a:

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

Prosseguir para o próximo tutorial: