O que é o Hoppscotch?
Neste post, vou compartilhar com você o que venho aprendendo sobre o Hoppscotch, os seus principais recursos e as suas diferenças em relação a outras ferramentas semelhantes.
O Hoppscotch é uma ferramenta de testes de API gratuita, open source e leve. O seu principal valor está em criar e usar requisições de forma rápida. Está disponível como aplicação web e também tem uma versão PWA (progressive web application) e, embora não exija cadastro para experimentar o serviço, é conveniente para salvar os resultados na nuvem.
O Hoppscotch oferece uma interface de usuário com suporte a conexões REST, WebSocket e GraphQL. Você pode enviar requisições a APIs em diferentes ambientes com facilidade usando o recurso de Environments e variáveis de ambiente do Hoppscotch. A abordagem de testes é parecida com a do Postman: um editor de código simples para escrever casos de teste em JavaScript.
Tabela comparativa
A tabela a seguir compara os principais recursos do Hoppscotch com a sua principal alternativa, o Postman, e também com o SoapUI, uma das principais ferramentas de testes de API do mercado.
| Hoppscotch | Postman | SoapUI |
|---|---|---|
| Gratuito e open source | Gratuito e planos pagos | Gratuito e planos pagos |
| Web e PWA | Web e desktop | Desktop |
| – REST.– GraphQL.– WebSocket.– Geração de documentação. | – Repositório de APIs.– Ferramentas de API.– GraphQL.– Integrações. | – SOAP/WSDL.– REST.– GraphQL.– JMS. |
| Workspace: – Pessoal. | Workspaces:– Pessoal.– Equipe.– Público. | Workspaces:– Projetos. |
| Collections:– New Folder, Edit, Export, Delete. | Collections:– Share, Run, Add Request, Add Folder, Edit, Monitor Collection, Mock Collection, View Documentation, Export, Rename, Duplicate, Delete.– Authorization, Pre-request script, Test, Variables.– Run.– Share. | Projetos:– TestSuites.– TestCases.– TestSteps. |
| Environments:– Variáveis. | Environments: – Variáveis.– Compartilhamento. | |
| Requisição: – GET, POST, PUT, PATCH, DELETE, HEAD, CONNECT, OPTIONS, TRACE, CUSTOM.– Parâmetros.– Body.– Headers.– Authorization.– Pre-request Script.– Tests. | Requisição:– GET, POST, PUT, PATCH, DELETE, COPY, HEAD, OPTIONS, LINK, UNLINK, PURGE, LOCK, UNLOCK, PROPFIND, VIEW.– Params.– Authorization.– Headers.– Body.– Pre-request Script.– Tests.– Settings. | Requisição:– GET, POST, PUT, DELETE, HEAD, OPTIONS, TRACE, PATCH, PROPFIND, LOCK, UNLOCK, COPY, PURGE.– Parâmetros.– Auth.– Headers.– Attachments.– Representations. |
| – | Servidores mock | Geração de serviço mock |
| – | Monitores | Monitoramento de APIs |
| – | Flows |
A minha experiência com o Hoppscotch
Os meus primeiros testes com a ferramenta foram para esta análise e foram feitos chamando a API do Swagger chamada PetStore.
Como mencionei, você pode usar tanto a versão web quanto a aplicação web progressiva. No meu caso, escolhi instalar a segunda, já que é muito simples e intuitiva de usar.
Ao entrar na aplicação em hoppscotch.io, aparece a opção de instalá-la localmente, o que é muito fácil de fazer. Na verdade, não é necessário configurar a aplicação de nenhuma forma, além de fazer login com uma das opções disponíveis para salvar o workspace na nuvem.
A primeira coisa que fiz foi criar as collections, organizando e armazenando nelas as diferentes requisições. As collections também podem ser exportadas como JSON e compartilhadas entre equipes.
Na hora de criar requisições, você pode usar parâmetros ou passar dados por meio de variáveis de ambiente.
Na seção de testes, você pode usar os snippets oferecidos pela ferramenta (por exemplo, validar que o status code é 200):
Gerar a documentação é muito simples. Vamos à seção Docs, selecionamos ou importamos as collections que queremos incluir e pressionamos “Generate documentation”.
Para criar um Gist com a documentação gerada, é preciso fazer login com o GitHub.
Prós
Apesar de ser uma ferramenta relativamente nova, lançada em 2019, segundo a comunidade no GitHub, hoje ela é usada por mais de 750.000 desenvolvedores no mundo todo e tem mais de 50.000 usuários mensais, o que a tornou uma ferramenta a considerar para testes de API.
Algumas das vantagens do Hoppscotch são:
- Leve e rápido.
- Gerador de documentação.
- O suporte a WebSocket também permite SSE, Socket.IO e MQTT (imagem 1).
- O suporte dedicado a GraphQL permite visualizar e criar requisições com facilidade (imagem 2).
- Os recursos crescem graças à colaboração da comunidade.
Imagem 1
Imagem 2
Contras
Pela mesma razão pela qual o Hoppscotch é escolhido por milhares de usuários, por ser uma ferramenta relativamente nova, ele pode ter algumas desvantagens.
Algumas das desvantagens são:
- Pouca documentação
- Faltam recursos para automação de testes
- É preciso adicionar alguns recursos via CLI.
Quando e por que usar o Hoppscotch
O Hoppscotch é a ferramenta ideal para projetos que exigem testes manuais e ágeis.
Como disse o criador do Hoppscotch, Liyas Thomas, no blog dev.to, é uma ferramenta que roda online, consome muito poucos recursos, suporta várias plataformas e dispositivos e pode ser acessada de qualquer lugar. Nas palavras dele: “Não existe outra ferramenta tão simples, minimalista e eficiente.”
Outro recurso que torna o Hoppscotch interessante é que ele pode ser personalizado: o fundo, a cor de destaque, o tamanho da fonte, o idioma e outros recursos que vêm melhorando com a colaboração da comunidade.
Também é possível configurar um middleware entre a aplicação e as APIs, seja por meio de um proxy ou adicionando extensões para Chrome ou Firefox:
O diagrama a seguir mostra como o ProxyScotch funciona:
Por fim, para quem tem interesse em entender mais sobre o Hoppscotch, vale conferir os seguintes repositórios:
- Hoppscotch: ecossistema de desenvolvimento de API.
- Docs: documentação do Hoppscotch.
- Hopp-doc-gen: CLI geradora de documentação de API.
- Hoppscotch-extension: extensões de navegador que oferecem mais recursos.
- . github: ecossistema open source de desenvolvimento de API.
- Hopp-cli: cliente HTTP de linha de comando.
- ProxyScotch: um servidor proxy simples.
- Hopp-js-sandbox: executa scripts JS externos em sandboxes definidas, usadas pelos clientes do Hoppscotch.
Considerações finais
O Hoppscotch é uma ferramenta 100% gratuita e, segundo o seu criador, sempre será. É simples e intuitiva de usar. Consome muito poucos recursos em tempo real, o que a torna ideal para dispositivos mais simples e muito ágil em qualquer dispositivo.
Embora ainda esteja em desenvolvimento, no ritmo em que os seus recursos aumentam, não seria surpresa ver as suas funcionalidades de automação se igualarem às do seu equivalente, o Postman, em um futuro próximo.
Referências
Hoppscotch: https://hoppscotch.io/es
Documentação: https://docs.hoppscotch.io/
Repositórios: https://github.com/orgs/hoppscotch/repositories
Criador: Liyas Thomas
Siga a gente no LinkedIn, no Twitter, no Instagram e no Facebook para fazer parte da nossa comunidade!
Fique conectado
com a Abstracta
Notícias, artigos e recursos para construir software melhor.
Leia sobre nossa política de privacidade.
