• API,  Desenvolvimento de Software,  Ferramentas

    Primeiros passos com Postman

    Eu sou desenvolvedora web há mais de 6 anos, e apesar de o meu primeiro contato com web ter sido a partir do front-end, eu confesso que o meu ponto forte hoje é o back-end. Tenho conhecimento para fazer tarefas mais básicas no front-end, como por exemplo montar uma página html ou utilizar o jQuery, mas não conheço a fundo nenhum framework JavaScript.

    Quando estamos desenvolvendo uma API, é comum que haja a necessidade de testar o consumo da mesma, e isso pode ser feito através do front-end. Porém, se você assim como eu não possui tantos conhecimentos em frameworks JS, existe uma forma mais rápida e prática de testar sua API, utilizando uma ferramenta chamada Postman.

    Print screen da página index do site getpostman.com

    O Postman tem se tornado bem “famoso” de uns tempos pra cá, pois permite que a gente teste as nossas APIs de forma prática, simples e rápida através de chamadas HTTP. Ele está disponível para Windows, Mac e Linux, e você pode fazer o download aqui.

    Podemos realizar uma requisição com o Postman seguindo 3 passos simples:

    Exemplo de requisição utilizando o Postman

    Para mostrar em mais detalhes as chamadas com o Postman, eu vou utilizar uma API com dados mockados que desenvolvi para o 3º módulo do projeto She Sharp (logo mais em algum artigo falarei sobre o mesmo), que está no GitHub.

    O primeiro passo para realizar este teste é abrir e rodar a API no Visual Studio. Se você não tiver uma API pronta, pode clonar a minha no link acima.

    Ao rodar a aplicação, pelas configurações padrão, somos direcionados para a url http://localhost:61224/api/home, mas como vamos testar o endpoint de Membros, vamos fazer as chamadas para a url http://localhost:61224/api/membro.

    Testando consultas com método GET

    Abra o Postman. No primeiro momento, juntamente com o Postman aparecerá uma janela com várias opções para criação de requisições, coleções, dentre outras coisas.
    Podemos fechar esta tela, para criar nossa primeira requisição. Para testar uma consulta, escolheremos o método GET e no campo ao lado informaremos a URL, como mostra a imagem a seguir:

    Postman - Requisição GET

    Depois disso, basta clicar no botão Send, e abaixo da área da requisição, veremos o corpo da resposta.

    Postman - Corpo da resposta do request HTTP GET

    Na imagem acima, estão destacados o Código de retorno, o Tempo de resposta, o Tamanho da resposta e o Corpo da resposta. Nós podemos chamar essa mesma URL normalmente pelo browser, que vamos obter a mesma resposta. Porém, para consultas o Postman nos ajuda a visualizar as informações do corpo da resposta já formatadas.

    Testando a inclusão de membros com método POST

    Com o Postman já aberto, faremos algumas alterações para realizar a nossa requisição para simular a inclusão de um membro na API.

    O primeiro passo é alterar o método HTTP para POST.
    Após alterar o método, selecione a aba Body, pois enviaremos os dados do novo membro através do corpo da requisição.
    Informe os campos que a sua API espera para cadastrar as informações. Neste caso, as informações esperadas são o Nome e o RG do novo membro e estas informações estão em formato JSON. É necessário informar o formato em que os dados serão enviados, como destacado na imagem abaixo:

    Postman - Requisição POST

    Quando todos os dados estiverem prontos, basta clicar na opção Send novamente.
    No caso da minha API, fiz com que fosse possível simular a inclusão de um membro, e o retorno da requisição me traz o id que foi criado para o mesmo, além do que já foi enviado na requisição.
    Para que possamos visualizar os dados de retorno, basta descer com a barra de rolagem até o final que veremos uma resposta semelhante à da requisição GET, porém agora somente com o novo membro criado:

    Postman - Corpo da resposta do request HTTP POST

    E assim podemos utilizar o Postman para testar as nossas APIs sem muito esforço. É claro que ele não substitui uma aplicação front-end que consuma e apresente as informações da API para os nossos usuários, mas é realmente muito prático e simples de testar o nosso código do back-end com ele.

    A partir disso, podemos utilizar o Postman com outros métodos HTTP e até mesmo para fazer testes que nos exijam mais detalhes, como detalhes de autenticação, por exemplo; mas isso fica para outro post!

    Abraços,
    Ana Manzan