Testes e desenvolvimento de API envolvem muitos detalhes, incluindo a data atual dentro das requisições GET. Isso pode ser um aspecto crucial para simular cenários do mundo real.
Experimente o Apidog gratuitamente hoje clicando no botão abaixo!
Este artigo explora dois métodos eficazes para incorporar a data atual como um valor de requisição GET dentro do Postman, um cliente de API popular. Vamos nos aprofundar na utilização de scripts de pré-requisição e variáveis de ambiente, equipando você com as ferramentas necessárias para construir requisições GET dinâmicas e adaptáveis.
O que é Postman?
Postman simplifica o processo de desenvolvimento de API para programadores. Ele fornece uma variedade de recursos que permitem que eles projetem, testem e documentem APIs em um só lugar. Esta coleção de ferramentas torna o Postman a escolha preferida para desenvolvedores que trabalham em qualquer projeto envolvendo APIs.
Scripts de Pré-requisição do Postman
No Postman, os scripts de pré-requisição são trechos de código JavaScript que são executados antes de você enviar uma requisição de API. Eles funcionam como uma estação de preparação, permitindo que você realize ações e manipulações na sua requisição logo antes de ela ser enviada.
Modificação Dinâmica da Requisição
Scripts de pré-requisição permitem que você modifique suas requisições de API em tempo real usando JavaScript. Isso possibilita a incorporação de elementos dinâmicos como a data atual, dados de teste aleatórios ou tokens de acesso com base em cenários específicos.
Configurabilidade
Esses scripts podem ser escritos em vários níveis dentro do Postman, oferecendo flexibilidade:
- Nível de Requisição: Scripts escritos aqui são específicos para aquela requisição em particular.
- Nível de Coleção: Scripts neste nível são executados antes de cada requisição dentro de uma coleção.
- Nível de Pasta: Esses scripts se aplicam a todas as requisições filhas dentro de uma pasta designada.
Reusabilidade Aprimorada
Scripts podem ser projetados para aproveitar dados de ambientes ou requisições anteriores, promovendo reusabilidade e reduzindo código repetitivo.
Customização de Componentes da Requisição
Você pode modificar vários aspectos de sua requisição usando scripts de pré-requisição, incluindo cabeçalhos, conteúdo do corpo e parâmetros de consulta.
Depuração e Registro
Esses scripts permitem que você registre informações no console do Postman, ajudando na depuração de suas interações com a API e na solução de quaisquer problemas.
Guia Passo a Passo Sobre Como Passar a Data Atual Como Valor de Requisição GET
Passo 1 - Crie uma Conta no Postman
Crie uma nova conta no Postman (somente se você não tiver uma) e comece baixando o aplicativo Postman para o seu dispositivo. O aplicativo oferece mais recursos do que a sua versão web.
Passo 2 - Crie uma Nova Requisição de API no Postman
Uma vez que você tenha instalado o Postman, crie uma nova requisição clicando no botão Novo no canto superior esquerdo da janela do Postman. Selecione Requisição HTTP para criar uma nova requisição, conforme mostrado na imagem acima.
Passo 3 - Insira o Método e os Detalhes da API
Em seguida, você precisa incluir os detalhes da requisição de API que deseja criar. Deve incluir componentes como a URL, métodos HTTP e parâmetros adicionais que a API exigirá.
Passo 4 - Abra a Seção de Script de Pré-requisição
Na sua API completa, procure pela seção Script de Pré-requisição, conforme mostrado na imagem acima.
Passo 5 - Insira o Código Necessário Para Incluir a Data
Na aba Script de Pré-requisição, adicione as seguintes linhas de código para que você possa incluir a data atual.
var moment = require('moment');
pm.environment.set('currentdate', moment().format(("YYYY-MM-DD HH:MM:SS")));
Para este exemplo em particular, a timestamp será armazenada na variável currentdate usando o método pm.environment.set.
Passo 6 - Inclua a Variável currentdate como uma Variável de Requisição
Adicione a variável currentdate à seção de parâmetros de consulta da sua requisição GET para que toda vez que você enviar uma requisição, possa observar a data atual.
Apidog - Personalize APIs
Se você está procurando uma potente plataforma de desenvolvimento de API, considere Apidog como uma alternativa ao Postman. O Apidog agiliza o processo ao lidar com muitos dos detalhes intricados por você. Mergulhe nas seções seguintes para explorar como o Apidog ajuda você a visualizar esses específicos da API!
Incluindo a Data Atual nos Cabeçalhos da Requisição no Apidog
Para incluir o timestamp atual no cabeçalho da requisição da API, siga os passos abaixo!
O seguinte código pode ser utilizado para incorporar a data atual em um cabeçalho de requisição de API. Basta copiar e colar essas linhas em um script personalizado na seção de Scripts de Pré-requisição (anteriormente rotulada como Pré-processadores) conforme ilustrado na imagem.
var timestamp = new Date().getTime();
pm.environment.set("timestamp", timestamp);
Uma vez que você tenha inicializado a variável timestamp, certifique-se de adicionar a variável como um parâmetro de consulta. Veja a imagem acima como referência.
Visualizando Data e Mais na Requisição de API do Apidog
O Apidog vai além de timestamps básicos. Ele fornece detalhes aprofundados da API, incluindo cookies e formatos de requisição bruta. Esta visão abrangente capacita você a identificar problemas e refinar suas APIs para um deployment sem falhas. Além disso, considere testes de carga de API para avaliar ainda mais a robustez da sua API.
Em conclusão, este artigo explorou dois métodos eficazes para incorporar a data atual como um valor de requisição GET dentro do Postman: scripts de pré-requisição e variáveis de ambiente. Scripts de pré-requisição oferecem flexibilidade para manipulação dinâmica, enquanto variáveis de ambiente proporcionam reusabilidade entre requisições. Ao utilizar essas técnicas, você pode construir requisições GET adaptáveis e dinâmicas que simulam cenários do mundo real e aumentam a eficácia dos seus testes e desenvolvimento de API.
Além disso, a capacidade de incluir elementos dinâmicos como a data atual ressalta o poder do Postman como uma ferramenta de desenvolvimento de API. Isso capacita você a criar casos de teste mais robustos e realistas, levando, em última análise, ao deployment de APIs que estão bem equipadas para lidar com uma gama mais ampla de condições.
