Como enviar uma solicitação ao REST Web API

Tipo de solicitação

O teste REST Web API suporta diferentes métodos HTTP que podem ser usados de acordo com seus objetivos de teste. Ao selecionar uma solicitação GET, você simplesmente recuperará dados de sua Web API. Embora os parâmetros da solicitação possam ser incluídos na URL, recomenda-se usar métodos dedicados para empurrar a carga útil para uma API.

Para enviar qualquer informação personalizada, alterar dados ou acionar qualquer fluxo ou evento, use tipos de solicitação como POST, PUT, ou PATCH.  Neste caso, para especificar o corpo da solicitação, navegue até a seção Post Data.

Se você definir o tipo de solicitação para POST, PUT, ou PATCH, mas não especificar os parâmetros da solicitação na seção Post Data, o tipo de solicitação será alterado de volta para GET ao salvar a tarefa.

Authentication

Se sua API requer autenticação, forneça as credenciais na seção Basic Authentication. Se autenticação baseada em token é o método utilizado, siga as recomendações fornecidas para OAuth 2.0-based APIs e configure os parâmetros de autenticação de forma similar.

Pós-dados

Nesta seção, você pode fornecer facilmente quaisquer entidades de solicitação, tais como JSON.

Para especificar o corpo do pedido, basta colar ou inserir o conteúdo do JSON no campo. O sistema analisará automaticamente o código e você será solicitado a selecionar um cabeçalho do tipo de conteúdo com base no tipo de corpo da solicitação. Além disso, você pode fornecer um cabeçalho de tipo de conteúdo personalizado, se necessário.

Uma vez especificado, o tipo de conteúdo será automaticamente adicionado à seção Líderes.

Criação de uma coleção de solicitações

Você pode apresentar quantas solicitações quiser dentro de um teste. Note que todas as solicitações devem ser adicionadas ao teste na ordem em que devem ser executadas.

Para estabelecer um teste de multi-pedidos:

  1. Primeiro, criar e salvar um novo teste Rest Web API.
  2. Para configurar uma seqüência de solicitações dentro do teste, na lista de testes, a partir do menu de ação do teste , select Add Target.
  3. Configure as configurações de solicitação e salve as alterações. Os pedidos serão listados na barra lateral na tela de edição do dispositivo, na ordem em que serão executados. Para acessar os parâmetros de solicitação, selecione o item correspondente na barra lateral.
  4. Para adicionar a próxima solicitação de dentro da interface de edição do dispositivo, clique no botão “mais” na barra

Para saber mais informações sobre a configuração e monitoramento de dispositivos de múltiplos alvos, veja Adicionando vários alvos dentro de um único dispositivo.

Validação dos resultados

Em geral, não é suficiente simplesmente fazer uma chamada para um API, o propósito de garantir que a resposta do API contenha dados que se esperava receber. Para verificar a resposta da API, é suficiente encontrar algumas palavras-chave que correspondam exatamente na resposta. Conhecendo o conteúdo de sua resposta API, você pode fornecer as palavras-chave na seção Validação do conteúdo. Para obter detalhes, veja a seção Keyword article.

Casos de uso

Vamos considerar um e-mail REST API como um exemplo. Para monitorar o serviço, precisamos enviar a solicitação POST para o ponto final da API correspondente, juntamente com os detalhes do e-mail no corpo da solicitação. Para fazer isso, temos que fornecer o endpoint URL e selecionar o tipo de solicitação POST.

Como o e-mail REST API requer autenticação básica, também precisamos fornecer as credenciais na seção correspondente.

Na seção Post Data, especificaremos a matriz JSON com detalhes de e-mail e selecionaremos o tipo de cabeçalho para empurrar a carga útil para o ponto final da API.

O próximo passo é especificar uma palavra-chave a ser procurada na resposta API para sua validação.

  • REST API Monitoring

    A maioria das aplicações web modernas utiliza uma API REST para se comunicar com o servidor e para se integrar entre si. Assegurando a qualidade adequada dos dados na API, nós garantimos a qualidade de todo o serviço web que a utiliza.

    Digamos que você criou o RESTful API para seu serviço web, e é necessário controlar que todas as funções do API estejam funcionando corretamente e disponíveis 24 horas por dia, 7 dias por semana. Mas por que precisamos testar uma WEB API, não é mais fácil testar uma interface de usuário para problemas? Vamos discutir as vantagens mais comuns dos testes e monitoramento da API.

    A primeira vantagem do teste REST API é que ele ajuda a identificar uma fonte particular de um problema. Ao testar seu API, você pode encontrar qual função específica é executada com erros.

    Além disso, com os testes API você não precisa construir um ambiente de teste dedicado para testar sua funcionalidade de serviço web. Ao contrário dos testes de IU que requerem uma cadeia de ações do usuário em uma janela do navegador para enviar uma solicitação a um servidor web, os testes e monitoramento de API podem ser realizados usando ferramentas automatizadas para enviar uma solicitação de endpoint específica. Por exemplo, esta abordagem permite contornar problemas como falhas em testes falsos no nível da GUI.

    Embora você possa testar todas as funções do API manualmente, é um processo difícil e demorado. Além disso, toda vez que você faz mudanças ou adiciona novas funcionalidades à sua API, os testes devem ser executados novamente para ter certeza de que as atualizações não afetaram a funcionalidade da API. O monitoramento REST API automatizado permite evitar as desvantagens dos testes manuais e pode trazer sua rotina de monitoramento API para o próximo nível.

    Monitoramento REST API com o Dotcom-Monitor

    O Dotcom-Monitor oferece duas opções para o monitoramento automatizado do desempenho API:

    • O dispositivo de monitoramento REST Web API.
    • O dispositivo de monitoramento de coleta dos carteiros.

    Para configurar o teste de monitoramento RESTful API a partir do zero, é recomendável usar nosso dispositivo de monitoramento REST Web API. Este tipo de dispositivo de monitoramento permite configurar uma simples solicitação HTTP para um endpoint API com uma autenticação básica e parâmetros POST.

    Caso você já tenha usado o carteiro para executar os testes de seus serviços RESTful API, é recomendado importar sua coleção de carteiros para o Dotcom-Monitor. Uma vez que a coleta dos pedidos dos carteiros foi importada para o sistema, você pode configurar o dispositivo de monitoramento de coleta de carteiros para automatizar o monitoramento de seus serviços API.

    Embora o dispositivo REST Web API suporte a execução de pedidos múltiplos, em alguns casos pode ser complicado de configurar. Por sua vez, se você estiver familiarizado com a ferramenta, Postman é ótimo para configurar solicitações HTTP parametrizadas e testes de asserção para monitoramento REST Web API.

    Assim, se você quiser criar um teste com uma seqüência complicada de chamadas API ou quando for necessária uma autenticação diferente da autenticação básica, use o carteiro para criar uma coleção de chamadas API. Em seguida, simplesmente importe-a para o dispositivo de coleta Dotcom-Monitor Postman e configure o monitoramento como descrito no Postman Monitoring (Collection Tasks) with Dotcom-Monitor APIs. O Dotcom-Monitor executará chamadas API com uma freqüência especificada (até 1 min), gerará relatórios e enviará notificações de erro de monitoramento para um endereço fornecido.

    Não deixe de conferir nosso conjunto full de ferramentas de monitoramento API no Dotcom-Monitor para ajudar a garantir a confiabilidade das aplicações e serviços web!