Resterm

Um workbench de API-as-code para o terminal.
resterm.app · docs

Resterm é um cliente de API que usa arquivos .http/.rest como código-fonte. Quase todos os recursos ficam nos arquivos .http, então são fáceis de revisar no Git ou em qualquer outro sistema de controle de versão. Você pode enviar requisições, testar fluxos de API, gravar tráfego HTTP e executar servidores mock locais diretamente pela TUI ou rodar as mesmas definições em scripts e CI com o comando resterm run.

Por que Resterm

• Teste fluxos completos de API. Faça login, capture um token, crie um recurso e verifique o resultado. Adicione asserções, loops, condições, retries e scripts diretamente nos seus arquivos de requisição.
• Transforme tráfego real em mocks locais. Grave requisições e respostas HTTP e salve-as como requisições executáveis ou definições de mock. Mantenha os mocks junto das requisições que os usam.
• Descubra o que mudou. Compare respostas entre ambientes, faça diff com resultados anteriores, inspecione tempos de requisição e faça profiling de execuções repetidas.
• Execute as mesmas verificações localmente e no CI. Use a interface de terminal durante o desenvolvimento e depois execute esses arquivos com resterm run. Exporte relatórios JSON ou JUnit.
• Trabalhe com vários protocolos. Envie requisições HTTP, GraphQL e gRPC, e trabalhe com streams WebSocket e SSE.

Túneis SSH e port-forwards de Kubernetes integrados permitem que você acesse APIs atrás de um bastion ou dentro de um cluster.

Sem conta, sem telemetria, sem recursos de IA.

Capturas de tela

Trace e timeline

Clique para ver mais da interface

Workflows

Profiler

Explain

RestermScript

Instalação

macOS e Linux:

brew install resterm
# or
curl -fsSL https://raw.githubusercontent.com/unkn0wn-root/resterm/main/install.sh | bash

Windows:

iwr -useb https://raw.githubusercontent.com/unkn0wn-root/resterm/main/install.ps1 | iex

Com Go 1.25 ou mais recente:

go install github.com/unkn0wn-root/resterm/cmd/resterm@latest

Binários pré-compilados para macOS, Linux e Windows estão na página de releases. Os binários para Linux precisam de glibc 2.32 ou mais recente.

Para atualizar, execute brew upgrade resterm se você instalou com Homebrew. Caso contrário, execute resterm --update. Mais no guia de instalação.

Início rápido

mkdir my-api && cd my-api
resterm init
resterm

resterm init cria um arquivo requests.http com algumas requisições de exemplo e mocks locais para respondê-las, então você não precisa de uma API real para experimentar. Pressione g Shift+M para iniciar o servidor mock, mova o cursor até uma requisição e pressione Ctrl+Enter para enviá-la. Pressione ? para obter ajuda a qualquer momento.

Você também não precisa do init. Execute resterm, digite uma URL ou cole um comando curl e pressione Ctrl+Enter.

O mesmo arquivo também roda sem a interface. Inicie os mocks em um terminal e execute uma requisição em outro:

resterm mock requests.http                       # terminal 1
resterm run --request CreateUser requests.http   # terminal 2

Arquivos de requisição

Resterm lê o formato padrão .http e adiciona diretivas # @ por cima para configurações e automação:

# @setting base-url https://api.example.com/v1/

### Create users
// Send this request once for each name in the list.
# @for-each ["david", "tom"] as name
# @when env.mode == "development"
# @assert response.statusCode == 201
POST users
Content-Type: application/json

{"name":"{{= name }}"}

Um @setting antes da primeira requisição se aplica ao arquivo inteiro. ### inicia uma nova requisição. Diretivas acima de uma requisição podem repeti-la, ignorá-la ou verificar a resposta.

Há mais exemplos em _examples/, e todas as diretivas estão listadas na referência de arquivos de requisição.

Documentação

A documentação completa está em resterm.app/docs. Bons lugares para começar são workflows, servidores mock, gravação, a CLI e RestermScript.

Dentro da TUI, :help <topic> abre o manual integrado e :docs <topic> abre a mesma página no site.

Para executar arquivos de requisição a partir do seu próprio código Go, veja o pacote headless.

Patrocínio

Resterm é e sempre será gratuito e de código aberto. Se você gosta do meu trabalho, você pode patrociná-lo no GitHub.

Licença

Apache License 2.0.