No desenvolvimento de APIs, conseguir ferramentas que sejam úteis e que, ao mesmo tempo, poupe tempo dos desenvolvedores é uma verdadeira dádiva, pois essa interface desempenha um papel essencial na facilitação da interação entre vários componentes de software e aplicações.
Assim, para garantir que tudo funcione como o esperado, é crucial testá-la. Neste contexto o Postman surge como uma ferramenta fundamental.
No artigo de hoje, você irá conhecer tudo que precisa sobre esta ferramenta, o que é? como funciona, quais são os seus benefícios e muito mais. Fique como MOD e continue antenado como o mundo da tecnologia e programação.
Entenda o que é Postman
O Postman, é uma ferramenta popular utilizada por desenvolvedores, por facilitar o desenvolvimento, teste e documentação de APIs. Sendo muito utilizado para enviar solicitações HTTP (como GET, POST, PUT, DELETE) e visualizar as respostas dessas solicitações.
Benefícios do Postman para os desenvolvedores e equipes
Entre os muitos benefícios em se utilizar o Postmam, podemos destacar a possibilidade de criar e salvar conjuntos de solicitações API, organizando em coleções, executando e analisando as respostas recebidas eficientemente.
Outra opção muito apreciada pelos usuários do Postmam é a possibilidade de monitoração, para isso configurar monitoramentos para executar as coleções de solicitações em intervalos definidos, ajudando a garantir que sua API esteja sempre funcionando corretamente.
Saiba como funciona a interface do Postman
Criando uma solicitação: Você insere a URL da API, escolhe o tipo de solicitação (GET, POST, etc.), adiciona quaisquer parâmetros, cabeçalhos ou corpo da solicitação necessários, e envia a solicitação.
Visualizando a resposta: Após enviar a solicitação, o Postman exibe a resposta do servidor, incluindo a situação HTTP, cabeçalhos e corpo da resposta. Isso ajuda a depurar e testar a API. Automatizando Testes: Você pode escrever scripts em JavaScript para executar testes automatizados, validando a integridade da resposta, valores de dados específicos, etc.
Conceitos básicos do Postman
Embora seja uma aplicação relativamente simples de usar, o Postmam possui diferentes meios de testes de API, como podemos ver a seguir:
Solicitações HTTP
Você insere a URL da API, escolhe o tipo de solicitação (GET, POST, etc.), adiciona quaisquer parâmetros, cabeçalhos ou corpo da solicitação necessários, e envia a solicitação.
Coleções
Você pode organizar suas solicitações em coleções, que são agrupamentos lógicos de solicitações relacionadas. Isso facilita a reutilização e a organização de testes.
Variáveis
Variáveis são contêineres para valores que você pode referenciar em suas solicitações e scripts. As variáveis podem ser definidas em diferentes escopos, como global, de coleção, de ambiente e local. A título de exemplo: você pode usar variáveis para armazenar valores como URLs, tokens de autenticação, IDs de recursos, entre outros.
Como fazer requisições POST e GET e diferença entre elas
Para fazer requisições POST você deve:
- Abrir o Postman.
- Selecionar o método POST:
- Na barra de seleção, escolha “POST”.
- Insira a URL:
- Digite a URL do servidor para onde você quer enviar dados (por exemplo, https://api.exemplo.com/usuarios).
- Configure o corpo da solicitação:
- Vá para a aba “Body” (Corpo).
- Selecione “raw” (bruto) e “JSON” (ou o formato necessário)
- Digite os dados que você quer enviar no formato correto.
- Envie a solicitação:
- Clique no botão “Send” (Enviar).
- Veja a resposta:
O Postman mostrará a resposta do servidor, confirmando que os dados foram recebidos e um novo usuário foi criado.
Para fazer requisições GET você deve:
- Abra o Postman.
- Selecione o método GET:
- Na barra de seleção, escolha “GET.
- Insira a URL:
- Digite a URL do servidor de onde você quer obter dados (por exemplo, https://api.exemplo.com/usuarios).
- Envie a solicitação:
- Clique no botão “Send” (Enviar).
- Veja a resposta:
O Postman mostrará a resposta do servidor, incluindo dados como uma lista de usuários. Resumidamente, as diferenças entre POST e GET é basicamente que enquanto no GET busca informações do servidor, no POST você envia dados para o servidor para serem processados ou armazenados.
Ou seja, ele te trará a resposta dos dados que você solicitou, por exemplo: imagine fazer uma consulta para saber quais faculdades possuem o curso de medicina em São Paulo, o GET busca e retorna os dados específicos para essa cidade.
Agora para entender o Post, pense em enviar um formulário de contato. O POST leva as informações preenchidas por você (nome, e-mail, mensagem) para o servidor, que as processa e armazena os dados enviados.
Como acessar API pelo Postman
Postman é um aplicativo que, entre outras coisas, facilita o acesso aos dados de uma API. Para acessá-lo, primeiramente é necessário fazer o download do aplicativo, após instalação siga os passos a seguir:
1. Instale e configure o Postman.
2. Crie uma conta e faça o login.
3. Clique em New >> Get Request.
4. Na barra de navegação, basta selecionar a opção GET e colocar a seguinte URL que deve ser testada: faça seu login, inserindo e senha cadastrada no momento do registro da API. Para isso, clique na aba Body e coloque, copie e cole o seguinte código substituindo os valores abaixo por sua própria credencial:
“e-mail”: “nome@email.com”
“password”: “12345678
5. Será gerado um access_token, com o qual você pode retornar dados do nosso banco de dados. Certifique-se de que o formato escolhido esteja com a caixa selecionada RAW e que o retorno seja em JSON. Clique no botão azul SEND, o que retornará seu token mais abaixo na tela.
A etapa seguinte consiste em criar uma nova aba no Postman e utilizar a função GET. Isso que retornará os dados para dentro de seu aplicativo. Importante: não deixe de informar à sua aplicação o token que você utilizará, caso contrário o servidor não reconhecerá seu login. Clique em Authorization e escolha o tipo de autorização como Type = Bearer.
Na caixa do lado é possível colar o token que você acabou de gerar na outra aba. Lembrando que cada token é válido por uma hora. Seguindo esse passo você já acessou seu API por meio do Postmam, agora é só o testar.
Saiba como testar com Postman
Em primeiro lugar, tenha em mãos a documentação da API que você deseja testar. Ela fornecerá informações essenciais, como URLs de endpoints, métodos HTTP, cabeçalhos, parâmetros e respostas esperadas.
- Crie uma coleção para sua API: clique em “Collections” e depois em “New Collection”. Denomine a coleção e adicione alguma informação ou descrição que julgar necessário.
- Crie uma request para testar um endpoint: dentro da sua coleção, clique em “New Request”. No campo “URL”, insira a URL completa do endpoint que você deseja testar, incluindo o método HTTP (GET, POST, PUT, DELETE, etc.). Por exemplo: https://api.exemplo.com/v1/usuarios para um método GET.
- Defina os headers (cabeçalhos) da request (opcional): Clique em “Headers” no lado direito da tela. Adicione os headers necessários para a autenticação, autorização ou outras informações relevantes. Chave: Insira o nome do header. Valor: Insira o valor do header.
- Adicione parâmetros de request (opcional): Clique em “Params” no lado direito da tela.
- Escolha entre “URL Params” ou “Body Params” dependendo do método HTTP e da API.
- Chave: Insira o nome do parâmetro. Valor: Insira o valor do parâmetro.
- Escreva o corpo da request (para métodos como POST ou PUT): Clique em “Body” no lado direito da tela. Selecione o formato de corpo desejado (JSON, form-data, etc.). Insira os dados que você deseja enviar para a API no formato correto.
- Envie a request e analise a resposta: clique no botão “Send” para enviar a request para a API. O Postman exibirá a resposta da API, incluindo o código de status, headers, tempo de resposta e corpo da resposta.
- Analise a resposta para verificar se ela corresponde ao esperado e se a API está funcionando como esperado. Prontinho você fez seu primeiro teste Postmam.
Dica: Salve e repita: Salve sua request no Postman para utilizá-la posteriormente.
Repita as etapas 4 a 8 para testar outros endpoints da API e diferentes cenários.
Conclusão
O objetivo dos desenvolvedores é fornecer cada vez mais garantias para suas entregas com produtos cada vez mais estáveis e eficientes.
Portanto, testar todos os detalhes possíveis dos projetos em desenvolvimento, incluindo APIs, é um requisito fundamental para o sucesso do lançamento de um novo software. Conte com a MOD para sempre a par de todas as novidades do mundo tecnológico!
Sobre o autor
Deixe um comentário