Dicas para Extrair Dados de Resposta da API no Apidog

Quando testando APIs no Apidog, muitas vezes é necessário extrair valores específicos dos dados de resposta da API para processamento e uso adicionais (geralmente para fazer solicitações adicionais). Normalmente, os dados de resposta da API estão em formato JSON ou XML. O JSON é o formato mais comum e preferido, pois é conciso, legível e fácil de analisar. Portanto, este artigo se concentrará em técnicas para analisar dados JSON.

As principais partes da resposta que muitas vezes precisam de processamento são os cabeçalhos de resposta e o corpo da resposta. O Apidog fornece ferramentas integradas para extrair tanto os cabeçalhos de resposta quanto o conteúdo do corpo da resposta para análise. Neste post, exploraremos técnicas para extrair dados de resposta da API no Apidog.

Extraindo Cabeçalhos de Resposta no Apidog

Todas as respostas HTTP contêm cabeçalhos que fornecem metadados sobre a resposta. Os cabeçalhos de resposta são exibidos em um formato de lista junto com seus valores. Você pode rolar pela lista para inspecioná-los.

Frequentemente, você pode querer extrair um valor de cabeçalho específico para validação. Por exemplo, para testar uma API de autenticação, você pode querer afirmar que ela retorna um token válido na resposta.

O Apidog criará automaticamente uma variável armazenando o valor desse cabeçalho. Você pode, então, referenciar essa variável em etapas de teste subsequentes para validar o valor. Isso fornece uma maneira conveniente de extrair cabeçalhos de resposta para verificação.

Cabeçalhos de resposta de exemplo de uma API:

Para extrair o valor completo do cabeçalho com a chave "Session-Token", você pode simplesmente inserir o nome da chave na seção "Ação Pós" para a API.

No entanto, e se você quiser extrair apenas uma parte do valor do cabeçalho Session-Token, como apenas o valor de msToken? Nesse caso, você precisará usar um script com uma expressão regular para realizar a extração.

Para extrair o valor do Token do Session-Token, o script necessário seria:

pm.response.headers.toJSON()[2]['value'].toString().match(/msToken=([^;\s"]+)/)[1]

Neste script, primeiro obtemos o valor completo do cabeçalho Session-Token usando pm.response.headers. Então usamos uma expressão regular para extrair apenas o valor de msToken do Session-Token. Isso retorna um array, então indexamos o array para obter o valor real.

Extraindo Conteúdo do Corpo da Resposta

Além dos cabeçalhos, o corpo da resposta contém a carga útil retornada pela API. Para analisar o conteúdo da resposta, você primeiro precisa extrair ou analisar.

Se a resposta for dados JSON, o Apidog pode automaticamente convertê-los em variáveis JSON estruturadas. Para habilitar isso:

1. Na seção "Processadores Pós" para a API, selecione "Extrair Variável".

2. Preencha a expressão JSONPath e outras opções.

3. Após configurá-lo, envie a solicitação. O Apidog extrairá os valores de campo correspondentes dos dados de resposta com base na expressão JSONPath que você forneceu. Os valores extraídos serão automaticamente armazenados nas variáveis "Ambiente/Global/Temporária".

O Apidog analisará o JSON e criará variáveis para os dados que você pode referenciar em etapas de teste posteriores.

Para conteúdo não JSON, como XML ou texto simples, você pode precisar extrair partes específicas usando expressões regulares. O Apidog suporta a construção visual de padrões regex para corresponder e extrair substrings ou valores na resposta.

Em Resumo

Ser capaz de extrair dados de resposta é crítico para testes eficazes de API. O Apidog fornece ferramentas integradas flexíveis para extrair tanto cabeçalhos quanto conteúdo do corpo da resposta. A extração automatizada de JSON lida com casos de uso comuns, enquanto o regex oferece controle total para respostas complexas.

Coloque essas técnicas de extração de dados em prática em seus testes de API para simplificar a validação e melhorar a cobertura. O Apidog permite que você transforme dados de resposta em variáveis acionáveis para afirmar detalhes essenciais e alimentar etapas posteriores de teste. Testes mais robustos levam a APIs de maior qualidade e melhores experiências para o usuário.