Resterm

Eine API-as-Code-Workbench für das Terminal.
resterm.app · docs

Resterm ist ein API-Client, der .http/.rest-Dateien als Quellcode verwendet. Fast alle Funktionen leben in .http-Dateien, sodass sie in Git oder jedem anderen Versionskontrollsystem leicht zu überprüfen sind. Du kannst Anfragen senden, API-Abläufe testen, HTTP-Verkehr aufzeichnen und lokale Mock-Server direkt aus der TUI starten oder dieselben Definitionen in Skripten und CI mit dem Befehl resterm run ausführen.

Warum Resterm

• Teste komplette API-Abläufe. Melde dich an, erfasse ein Token, erstelle eine Ressource und überprüfe das Ergebnis. Füge Assertions, Schleifen, Bedingungen, Wiederholungsversuche und Skripte direkt in deinen Anfragedateien hinzu.
• Verwandle echten Verkehr in lokale Mocks. Zeichne HTTP-Anfragen und -Antworten auf und speichere sie als ausführbare Anfragen oder Mock-Definitionen. Bewahre Mocks neben den Anfragen auf, die sie verwenden.
• Finde heraus, was sich geändert hat. Vergleiche Antworten über Umgebungen hinweg, stelle Diffs gegen frühere Ergebnisse dar, untersuche Anfrage-Timings und profiliere wiederholte Ausführungen.
• Führe dieselben Prüfungen lokal und in CI aus. Verwende die Terminal-UI während der Entwicklung und führe diese Dateien dann mit resterm run aus. Exportiere JSON- oder JUnit-Berichte.
• Arbeite protokollübergreifend. Sende HTTP-, GraphQL- und gRPC-Anfragen und arbeite mit WebSocket- und SSE-Streams.

Integrierte SSH-Tunnel und Kubernetes-Port-Forwards ermöglichen dir den Zugriff auf APIs hinter einem Bastion oder innerhalb eines Clusters.

Kein Konto, keine Telemetrie, keine KI-Funktionen.

Screenshots

Trace und Timeline

Klicke, um mehr von der UI zu sehen

Workflows

Profiler

Explain

RestermScript

Installation

macOS und 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

Mit Go 1.25 oder neuer:

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

Vorgefertigte Binärdateien für macOS, Linux und Windows findest du auf der Releases-Seite. Die Linux-Binärdateien benötigen glibc 2.32 oder neuer.

Zum Aktualisieren führe brew upgrade resterm aus, wenn du mit Homebrew installiert hast. Andernfalls führe resterm --update aus. Mehr im Installationsleitfaden.

Schnellstart

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

resterm init erstellt eine requests.http-Datei mit einigen Beispielanfragen und lokalen Mocks, die sie beantworten, sodass du keine echte API zum Ausprobieren benötigst. Drücke g Shift+M, um den Mock-Server zu starten, bewege den Cursor zu einer Anfrage und drücke Ctrl+Enter, um sie zu senden. Drücke jederzeit ? für Hilfe.

Du benötigst auch kein init. Führe resterm aus, gib eine URL ein oder füge einen curl-Befehl ein und drücke Ctrl+Enter.

Dieselbe Datei läuft auch ohne die UI. Starte die Mocks in einem Terminal und führe eine Anfrage in einem anderen aus:

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

Anfragedateien

Resterm liest das Standard-.http-Format und fügt # @-Direktiven für Einstellungen und Automatisierung hinzu:

# @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 }}"}

Ein @setting vor der ersten Anfrage gilt für die gesamte Datei. ### startet eine neue Anfrage. Direktiven über einer Anfrage können sie wiederholen, überspringen oder die Antwort prüfen.

Weitere Beispiele findest du in _examples/, und jede Direktive ist in der Referenz zu Anfragedateien aufgeführt.

Dokumentation

Die vollständige Dokumentation findest du unter resterm.app/docs. Gute Einstiegspunkte sind Workflows, Mock-Server, Aufzeichnung, die CLI und RestermScript.

Innerhalb der TUI öffnet :help <topic> das integrierte Handbuch und :docs <topic> öffnet dieselbe Seite auf der Website.

Um Anfragedateien aus deinem eigenen Go-Code auszuführen, siehe das headless-Paket.

Sponsor

Resterm ist und bleibt kostenlos und Open Source. Wenn dir meine Arbeit gefällt, kannst du sie auf GitHub sponsern.

Lizenz

Apache License 2.0.