Criando um teste de API de REST

Crie um teste de API de REST para testar o tempo de resposta e a disponibilidade do aplicativo da web usando os métodos de HTTP a seguir: GET, POST, PUT e DELETE.

Sobre Esta Tarefa

Use testes de API de REST para monitorar a disponibilidade e o desempenho do aplicativo da web e outras URLs em resposta às chamadas de REST.

Procedimento

Para criar um teste de API de REST, conclua as etapas a seguir.

  1. Se estiver visualizando a página de resumo do Monitoramento de Disponibilidade para seu aplicativo, clique em Incluir novo teste.
    A página de resumo do Monitoramento de Disponibilidade para seu aplicativo.
    Se estiver visualizando o painel do Monitoramento de Disponibilidade, clique em Incluir novo teste na área de janela Testes sintéticos.

    O botão Incluir novo teste na área de janela Testes sintéticos.

  2. Clique em Ação única na página Configuração de monitoramento; em seguida, clique em API de REST na página Ação única.
  3. Insira um nome significativo para o seu teste no campo Nome. Inclua uma descrição do propósito de seu teste no campo Descrição.
  4. Na seção Solicitação, selecione o tipo de método na lista de Métodos e insira uma URL que você deseja testar com esse método.
    É possível escolher GET, PUT, POST ou DELETE. Se você escolher o método PUT ou POST, será possível inserir o conteúdo de corpo para testar no campo Corpo da solicitação (opcional).

    Por exemplo, o teste de API de REST a seguir usa o método POST para solicitar que seu app da web aceite dados, além de testar a disponibilidade e o desempenho desse aplicativos da web.

    Exemplo de um teste de API de REST que usa o método de solicitação POST.

  5. Opcional: Configure o teste para incluir um cabeçalho e valor específicos. Insira um nome de cabeçalho e valor de cabeçalho nos campos de Cabeçalho.

    Se o aplicativo da web que você deseja testar requerer um login de usuário e senha, insira "Autorização" no campo Nome do Cabeçalho. Insira a palavra Básico, um caractere de espaço e o valor codificado base64 de seu username:password no campo de Valor de cabeçalho.

    Por exemplo, se o seu nome de usuário for Aladdin e sua senha for OpenSesame, em seguida, insira a palavra Basic, um caractere de espaço, e o valor codificado base64 para Aladdin:OpenSesame no campo Valor do Cabeçalho.

    Campos de cabeçalho descrevendo credenciais de autorização de teste em base64.

  6. Configure o aviso e os limites de alerta crítico para o seu teste na seção Validação de resposta. Edite o Valor e a Unidade para cada linha.
    Os tempos de resposta que excedem o seu aviso e os limites críticos acionam alertas.

    Seção Validação de Resposta com limites crítico e de aviso padrão.

  7. Opcional: Clique em Incluir condição para definir e incluir condições de validação de resposta customizadas.
    As condições de validação de resposta customizadas são avaliadas em conjunto para gerar um alerta. É possível definir e incluir até seis condições customizadas para o seu teste.
    Importante:

    Em Monitoramento de Disponibilidade, cada teste pode gerar até um total de três alertas. Seu teste relata o alerta com a maior severidade até que todas as condições que causem alertas sejam resolvidas. Para obter mais informações, consulte Geração de alertas no Monitoramento de disponibilidade.

    É possível validar os dados a seguir:
    Código de resposta de cabeçalho
    Selecione Código de resposta de cabeçalho para testar um código de resposta ou um intervalo de códigos de resposta de HTTP.
    Propriedade de cabeçalho
    Selecione Propriedade de cabeçalho para testar para uma propriedade e valor específicos do campo de cabeçalho de HTTP.
    Corpo JSON
    Selecione Corpo JSON para testar uma propriedade específica a partir de um corpo JSON.

    Para cada condição, insira uma propriedade para a qual testar no campo de Destino e um valor a ser testado no campo de Valor. Selecione um operador no menu suspenso Operação. Finalmente, escolha uma Severidade do alerta de Aviso ou Crítico para a sua condição.

    Importante:

    Os valores numéricos que você insere no campo de Valor são tratados como números, e não sequências, por padrão. Para inserir um Valor para uma condição de validação de resposta, use aspas para distinguir entre uma sequência e um número. Por exemplo, para testar a sequência 123, insira "123" no campo Valor. Para verificar o número 400, insira 400 sem aspas.

    Condições de validação de resposta customizada para código de resposta do cabeçalho, propriedade do cabeçalho e corpo JSON.

  8. Clique em Verificar para criar o seu teste de API de REST e para determinar se a sua solicitação de teste é válida.

    O Monitoramento de Disponibilidade determina a validade do teste usando o método de HTTP selecionado e os cabeçalhos da solicitação definidos para o teste. Nenhuma validação de resposta ocorre durante a verificação de teste.

    O seu teste validado é exibido na tabela Itens verificados. É possível incluir mais URLs repetindo as etapas 3 a 8.

  9. Para definir as suas configurações de teste, clique em Avançar.

    Um resumo da configuração de teste é exibido. A mensagem a seguir é exibida para as configurações padrão:

    O teste ocorrerá: a cada 15 minutos a partir de três locais públicos e nenhum local privado simultaneamente para determinar se o teste excede o limite especificado.

  10. Na área de janela Configurações, clique em Editar para exibir as configurações atuais para o seu teste.
    É possível atualizar as seguintes configurações:
    • Intervalo define com que frequência o teste é executado.
    • Frequência de teste determina se o teste é executado em todos os locais simultaneamente ou em um local diferente a cada intervalo. Selecione Simultâneo para executar o seu teste em todos os locais simultaneamente ou selecione Escalonado para executar o seu teste de um local selecionado diferente a cada intervalo.
    • Locais determina os locais em que seu teste será executado
  11. Selecione seus locais da lista de Locais públicos. Para selecionar um local privado do qual executar o teste, você deve primeiro instalar e configurar um PoP privado na máquina a partir da qual deseja executar o teste. Para obter mais informações, consulte Instalando e configurando locais de PoP privado.
  12. Clique em Salvar para concluir a configuração de seu teste; em seguida, clique em Concluir.
    O painel Monitoramento de Disponibilidade é exibido. Após um minuto, o painel exibe informações e dados para o novo teste.