Client Rest no vscode, uma alternativa ao Postman

Resumo Introdução:

Muitos desenvolvedores quando estão construindo aplicações e API's utilizando o modelo REST, precisam validar seus recursos desenvolvidos e muitas vezes recorrem à instalação de ferramentas, programas ou softwares adicionais, para que assim possam testar seus projetos. Mas será que realmente é necessário sair da sua ferramenta de desenvolvimento para realizar tais validações e testes? A ideia desse documento é apresentar uma possibilidades de testar seus projetos e sem necessidade de sair de sua ferramenta de desenvolvimento e sem a necessidade do uso de programas adicionais, tais como Postman ou Insomnia.

Objetivo:

O nosso objetivo é prover uma alternativa ao uso de programas adicionais, e fazer com que durante o seu desenvolvimento você não precise sair da sua ferramenta de desenvolvimento, no nosso caso o Visual Studio Code [VSCode], então vamos ao propósito desse novo documento.

Método:

Para realizar o nosso estudo vamos precisar do plugin "Client Rest" [ https://marketplace.visualstudio.com/items?itemName=humao.rest-client ], que podemos instalar no VScode usando o comando Ctrl + P e depois digitanto [ ext install humao.rest-client ], ou procurando no menu de extensões o texto [ Client Rest ]. (conforme imagem)

Com o plugin instalado devemos criar um arquivo com a extensão [ .http ], exemplo [ api_test.http ], com esse tipo de arquivo e com o plugin, o VSCode irá criar menu de ações para validarmos os nossos testes, então vamos ao nosso primeiro arquivo de exemplo:

Resultados:

Conforme documentos e imagens a seguir iremos validar as situações possíveis que o plugin do [ Rest Client ] poderá nos auxiliar.

Podemos verificar que o VSCode criou entre as linhas 2 e 3 um link [ Send Request ], que nos possibilita realizar o consumo do recurso. Ao clicarmos no item teremos ao lado a seguinte saída com a resposta da solicitação. (conforme imagem)

O interessante é que podemos fazer o reaproveitamento dos dados da resposta e utilizar em outra requisição, tanto como URL como parâmetro BODY, vide exemplo:

Dessa forma podemos ter vários arquivos dentro do próprio projeto que estamos desenvolvendo e testar ele sem a necessidade de abrir outra ferramenta ou site para os nossos testes.

O [ Rest Client ] é muito poderoso, podemos criar variáveis e reaproveitar os dados, além de permitir o reaproveitamento dos dados vindo de outras chamadas, e outras funcionalidades como gerar GUID, datas, números aleatórios ...

No item acima, estamos simulando uma requisição post, gerando um GUID aleatório, um value com número aleatório entre 1 e 100, além de obter a data atual por parâmetro.

Conclusão:

Com base nesse documento, podemos validar que para testar nosso desenvolvimento podemos ficar dentro da nossa ferramenta de desenvolvimento sem a necessidade de fazer uso de itens adicionais, e o melhor podemos incluir esses arquivos no repositório do projeto e assim documentar itens para testar os endpoints, e outros desenvolvedores do time também ter conhecimento desses recursos.

Ferramentas como o Jetbrains e também Visual Studio possuem também possibilidades de ler esse arquivo de extensão "http" e assim facilitar o uso e teste das API's.

Se você chegou até aqui, fico grato por ter lido esse conteúdo e espero que o mesmo possa lhe ajudar em novos desenvolvimentos.

Fontes:

• https://github.com/Huachao/vscode-restclient
• https://marketplace.visualstudio.com/items?itemName=humao.rest-client