Postman pre-requests, ajudando você a desenvolver APIs

Testar APIs muitas vezes é chato pra caramba, a dica que eu trago hoje evita por exemplo que você fique passando por uma rota de login para gerar um token para depois “consumir” algum recurso da API, vamos a prática.

O cenário é o seguinte: você tem uma rota de autenticação que gera um token e depois esse token deve ser usado para consumir recursos na sua API, então você gera seu token copia e cola o mesmo no local específico para enviar no cabeçalho de requisição como na imagem abaixo.

O problema aqui é que você vai precisar sempre autenticar para consumir qualquer recurso da API, mas esse problema acaba agora veja como.

Pre-request scripts

Os scripts de pré-solicitação são trechos de código associados a uma requisição http que são executados antes da solicitação ser enviada. Isso é perfeito para casos de uso como incluir algum parâmetro no cabeçalho da requisição.

No nosso exemplo vamos incluir um cabeçalho Authorization.

Definindo uma pre-request

Na aba Pre-request Script:

escreva o seguinte código:

const echoPostRequest = {
  
  url: 'localhost:8000/api/v1/auth',
  method: 'POST',
  header: {
        'content-type': 'application/json',
    },
  body: {
        mode: 'raw',
        raw: JSON.stringify({ email: 'mail@mail.com', password: '123456' })
    }
};
pm.sendRequest(echoPostRequest, function (err, response) {
    var data = response.json();
    pm.environment.set("TOKEN", data.data.token);
});

No exemplo acima será necessário mudar as credenciais de acesso a sua API conforme a necessidade, depois basta ir até a aba Headers e passar os dados do cabeçalho dessa forma:

O postman seta TOKEN como uma variável de ambiente para assim ser usada globalmente.

pm.environment.set(“TOKEN”, data.data.token);

Adicionando uma pre-request a uma coleção ou pasta

Podemos adicionar pre-requests a uma coleção, uma pasta ou uma única requisição dentro de uma coleção. Um script pre-request associado a uma coleção será executado antes de cada solicitação na coleção. Associado a uma pasta será executado antes de cada solicitação na pasta. Isso permite que você reutilize o código normalmente executado antes de cada solicitação. Para isso basta clicar nos três pontinho ao lado de uma pasta e depois clicar em Edit->Pre-request Scripts, e escrever seu código como na imagem.

Essa dica tem facilitado muito meu dia a dia, espero que facilite o seu também.