Se você trabalha ou pretende trabalhar com desenvolvimento, testes ou suporte técnico, mais cedo ou mais tarde vai ouvir a pergunta: "já testou essa API?". Uma forma prática de responder é usar o Postman, uma ferramenta que permite enviar requisições a uma API e analisar as respostas sem precisar escrever um programa só para isso. Neste artigo você vai entender o básico e aprender um roteiro simples de uso.
O que é uma API e por que testá-la?
Uma API (Interface de Programação de Aplicações) é um conjunto de regras que permite que dois sistemas conversem. Em APIs web, o formato mais comum é o REST, em que o cliente envia uma requisição HTTP a um endereço (URL) e recebe uma resposta, geralmente em JSON. Aplicativos de celular, sites e sistemas internos usam esse tipo de comunicação o tempo todo.
Testar a API separadamente da tela do aplicativo ajuda a descobrir problemas mais cedo. Você pode verificar se o servidor responde, se os dados retornados estão corretos e se erros são tratados da forma esperada, sem depender de que o front-end já esteja pronto.
O que é o Postman?
O Postman é uma aplicação para montar, enviar e organizar requisições HTTP. Ele oferece uma interface visual em que você escolhe o método, informa a URL, adiciona cabeçalhos e corpo da requisição e vê a resposta formatada. Também permite agrupar requisições em coleções, criar variáveis e escrever testes automatizados simples. Está disponível para os principais sistemas operacionais e tem versão web.
Métodos HTTP mais usados
Antes de enviar a primeira requisição, vale conhecer os métodos que indicam a intenção da chamada:
| Método | Uso típico |
|---|---|
| GET | Consultar um ou vários recursos |
| POST | Criar um novo recurso |
| PUT | Substituir um recurso existente |
| PATCH | Alterar parte de um recurso |
| DELETE | Remover um recurso |
Passo a passo: sua primeira requisição
- Abra uma nova requisição. No Postman, crie uma aba de requisição vazia.
- Escolha o método. Para consultar dados, selecione GET.
- Informe a URL. Use o endereço do endpoint que você quer testar. Se estiver aprendendo, procure uma API pública de testes ou a documentação da API do seu projeto.
- Adicione parâmetros, se precisar. Filtros e paginação costumam ir na aba de parâmetros, que monta a parte da URL depois do ponto de interrogação.
- Envie. Clique em Send e observe o resultado.
Na parte inferior da tela, você verá o código de status, o tempo de resposta, o tamanho da resposta e o corpo retornado. Um status na faixa 200 indica sucesso, na faixa 400 indica erro do cliente (por exemplo, dados inválidos ou falta de autorização) e na faixa 500 indica erro no servidor.
Enviando dados com POST
Para criar um recurso, troque o método para POST, abra a aba de corpo (Body), escolha o tipo "raw" e o formato JSON e escreva os dados, por exemplo, um objeto com nome e e-mail. Verifique também a aba de cabeçalhos: normalmente é necessário informar o tipo de conteúdo como JSON, e o Postman costuma preencher isso automaticamente quando você escolhe o formato. Ao enviar, confira se o status indica criação e se os dados retornados correspondem ao que você mandou.
Autenticação
Muitas APIs exigem identificação. A aba de autorização do Postman oferece modelos prontos para formatos comuns, como token do tipo Bearer, autenticação básica e chaves de API. Nunca compartilhe tokens reais em prints ou em coleções públicas, pois eles funcionam como senhas.
Organizando com coleções e variáveis
Conforme os testes crescem, ficam repetitivos. Duas funções resolvem boa parte do problema:
- Coleções: agrupam requisições relacionadas, como todas as chamadas de um módulo, facilitando a execução em sequência e o compartilhamento com a equipe.
- Variáveis e ambientes: permitem guardar valores que mudam, como o endereço base do servidor. Em vez de repetir a URL completa, você escreve o nome da variável entre chaves duplas e troca o ambiente (desenvolvimento, homologação, produção) com um clique.
Escrevendo testes simples
O Postman permite escrever pequenos scripts em JavaScript que rodam depois da resposta. Mesmo sem ser programador experiente, você consegue criar verificações como: o status deve ser o esperado, o tempo de resposta deve ser menor que um limite e o corpo deve conter determinado campo. Quando esses testes passam a rodar em conjunto, você ganha uma espécie de rede de segurança: se alguém alterar a API e quebrar algo, o teste falha e o problema aparece rapidamente.
Lendo a resposta com atenção
Receber uma resposta não significa que tudo está certo. Depois de enviar a requisição, vale conferir quatro pontos: o status, que mostra se a operação foi aceita; os cabeçalhos da resposta, que informam o tipo de conteúdo e outras regras; o corpo, que traz os dados; e o tempo de resposta, que ajuda a perceber lentidão. Se o corpo vier em JSON, o Postman o exibe de forma organizada, com campos recolhíveis, o que facilita encontrar o valor que você procura.
Também é útil guardar exemplos de respostas. Ao salvar um exemplo na requisição, você registra como a API se comporta em situações de sucesso e de erro, criando uma documentação viva que ajuda novos integrantes da equipe a entender o fluxo sem precisar perguntar a cada dúvida. Quando algo mudar, basta comparar a nova resposta com o exemplo salvo e identificar a diferença.
Boas práticas
- Nomeie as requisições de forma clara, descrevendo a ação e o recurso.
- Use ambientes para separar dados de teste dos de produção.
- Teste também os casos de erro, como campos faltando, tokens inválidos e recursos inexistentes.
- Leia a documentação da API antes de testar e compare o comportamento real com o esperado.
- Documente a coleção para que outras pessoas consigam reutilizá-la.
Conclusão
Dominar uma ferramenta como o Postman é um passo importante para quem atua em desenvolvimento, QA ou suporte, porque transforma conversas abstratas sobre APIs em testes concretos e repetíveis. Para continuar evoluindo, explore os cursos de ferramentas de TI, desenvolvimento back-end e testes de software da Cursa, que aprofundam esses temas com exemplos práticos.
