Hoppscotch ist ein Open-Source-API-Ökosystem; eine Web-App, Desktop-App, CLI und ein selbst hostbares Backend, oft als offene Alternative zu Postman und Insomnia beschrieben. Die Hoppscotch CLI ist der Teil, der die Sammlungen, die Sie in diesem Ökosystem erstellen, nimmt und sie von einem Terminal aus ausführt, was genau das ist, was Sie für CI/CD benötigen.
Dieser Leitfaden erklärt, was die Hoppscotch CLI ist, wie man sie installiert und wie der Befehl hopp test tatsächlich funktioniert, mit den realen Flags und einem funktionierenden CI-Beispiel. Wenn Sie sie mit anderen Runnern vergleichen, vergleicht der Beitrag Die besten Hoppscotch CLI Alternativen die Optionen, und Apidog CLI vs Hoppscotch CLI ist der direkte Vergleich.
Was die Hoppscotch CLI ist
Die Hoppscotch CLI wird als npm-Paket @hoppscotch/cli ausgeliefert. Ihre Aufgabe ist eng und nützlich: Eine Hoppscotch-Sammlung nehmen, jede Anfrage darin ausführen, die Testskripte ausführen, die an diese Anfragen angehängt sind, und mit einem Pass/Fail-Code beenden, den Ihre Pipeline lesen kann.
Das macht sie zu einem Sammlung-Runner, derselben Kategorie wie Newman für Postman oder inso für Insomnia. Sie entwirft keine APIs, mockt keine Endpunkte oder generiert keine Dokumente. Sie führt Anfragen aus und überprüft Zusicherungen. Für ein kostenloses, Open-Source-Tool, das Sie auch selbst hosten können, ist dieser Fokus der springende Punkt.
Da Hoppscotch Open Source ist, können Sie den gesamten Stack selbst betreiben und die CLI auf Ihre eigene Instanz verweisen. Teams, die ihre Anfragedaten nicht in einer Cloud eines Anbieters speichern möchten, neigen dazu, das zu mögen. Der Kompromiss ist, dass Sie das Hosting selbst verantworten.
Installation der Hoppscotch CLI
Installieren Sie sie global von npm:
npm i -g @hoppscotch/cli
Eine wichtige Anforderung: Die aktuelle CLI benötigt Node.js v22 oder neuer. Wenn Sie noch Node 20 verwenden, können Sie bei CLI v0.26.0 bleiben, aber die neuesten Releases setzen v22+ voraus. Überprüfen Sie Ihre Version, bevor Sie sie in einen Build-Agent einbinden:
node --version
hopp --version
Wenn Ihr CI-Image eine ältere Node-Version liefert, fixieren Sie die Laufzeit in der Pipeline auf v22, sonst erhalten Sie einen Installations- oder Laufzeitfehler, der nicht mit Ihren Tests zusammenhängt.
Der Befehl hopp test
Alles läuft über hopp test. Die grundlegende Form verweist auf eine Sammlungsdatei:
hopp test ./my-collection.json
Sie können eine Umgebungsdatei und eine Verzögerung zwischen Anfragen übergeben:
hopp test ./my-collection.json -e ./staging.env.json -d 500
Hier liefert -e (oder --env) die Umgebung, und -d (oder --delay) wartet die angegebene Anzahl von Millisekunden zwischen Anfragen, was hilfreich ist, wenn Sie eine API mit Ratenbegrenzung verwenden.
Wenn Ihre Sammlungen in einer Hoppscotch-Instanz (Cloud oder selbst gehostet) und nicht in einer lokalen Datei liegen, verweisen Sie auf sie über die ID und authentifizieren sich mit einem persönlichen Zugriffstoken:
hopp test <collection-id> --token <access_token> --server https://hoppscotch.your-company.com
--token enthält Ihr persönliches Zugriffstoken, und --server verweist auf Ihre selbst gehostete URL. Lassen Sie --server weg, wenn Sie die gehostete Hoppscotch-Cloud nutzen.
Datengesteuerte Ausführungen und Berichterstattung
Zwei Flags verwandeln hopp test von einem einzelnen Durchlauf in etwas CI-freundliches.
Für datengesteuerte Tests speisen Sie eine CSV-Datei ein und legen fest, wie viele Iterationen ausgeführt werden sollen:
hopp test ./my-collection.json --iteration-data ./users.csv --iteration-count 3
--iteration-data nimmt eine CSV-Datei, deren Spalten zu Variablen in jeder Ausführung werden, und --iteration-count steuert, wie oft die Sammlung wiederholt wird. Das ist die gleiche Idee wie Newmans -d und deckt den gängigen Fall ab, "diesen Anmeldevorgang mit 50 Konten auszuführen".
Für die Berichterstattung schreibt die CLI JUnit XML, das die meisten CI-Systeme nativ einlesen können, um Testergebnisse anzuzeigen:
hopp test ./my-collection.json --reporter-junit ./report.xml
JUnit ist das einzige strukturierte Berichtsformat, das die CLI erzeugt. Wenn Sie HTML-Artefakte oder gehostete, verlinkbare Berichte benötigen, ist das eine Lücke, die Sie kennen sollten, bevor Sie sich festlegen. Tools wie die Apidog CLI geben CLI-, HTML- und JSON-Berichte zum Vergleich aus.
Was während einer Ausführung tatsächlich ausgeführt wird
Wenn Sie hopp test ausführen, durchläuft die CLI die Sammlung der Reihe nach und führt für jede Anfrage Folgendes aus:
- führt das Pre-Request-Skript aus,
- sendet die Anfrage,
- führt das Testskript aus und wertet jede Zusicherung aus.
Testskripte verwenden die Skripting-API von Hoppscotch: pw.test() definiert einen Testblock und pw.expect() macht Zusicherungen darin. Ein kleines Beispiel, das an eine Anfrage angehängt ist, sieht so aus:
pw.test("Status is 200", () => {
pw.expect(pw.response.status).toBe(200);
});
Wenn eine Zusicherung fehlschlägt, beendet der Befehl mit einem von Null verschiedenen Code. Wenn alles erfolgreich ist, wird 0 zurückgegeben. Dieses Verhalten des Exit-Codes ist der gesamte Vertrag mit CI: Ein Exit-Code ungleich Null führt zum Fehlschlagen des Builds, was genau das ist, was Sie wollen.
Ein GitHub Actions Beispiel
Das Einbinden von hopp test in CI ist kurz. Dieser Workflow installiert die CLI auf einem Node 22 Runner und führt bei jedem Push eine Sammlung aus:
name: API tests
on: [push]
jobs:
hopp:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-node@v4
with:
node-version: 22
- run: npm i -g @hoppscotch/cli
- run: hopp test ./collection.json -e ./ci.env.json --reporter-junit ./report.xml
Der Schritt setup-node, der v22 festlegt, ist der Teil, den die Leute vergessen. Ohne ihn könnte der Standard-Runner-Node für die aktuelle CLI zu alt sein.
Einschränkungen, die zu beachten sind
Die Hoppscotch CLI ist gut in dem, was sie tut, und ehrlich in ihrem Umfang:
- Es ist ein Sammlung-Runner, keine Plattform. Kein Design, Mocking oder Dokumentation. Diese müssen Sie von anderswo mitbringen.
- Sie exportieren oder hosten Sammlungen selbst. Die CLI führt eine Sammlungsdatei aus oder zieht eine von einer Instanz, auf die Sie sie verweisen.
- JUnit ist der einzige strukturierte Bericht. Keine integrierten HTML- oder gehosteten Berichte.
- Node v22+. Eine zwingende Anforderung für aktuelle Releases.
Nichts davon ist ein Nachteil; es ist der Preis eines kleinen, kostenlosen Open-Source-Tools. Wenn Ihre Anforderungen über "eine Sammlung in CI ausführen" hinausgehen, hin zu Design, Mocking, datengesteuerten Ausführungen mit reichhaltigeren Berichten und der Verwaltung von API-Ressourcen als Code, dann kommt eine integrierte Plattform ins Spiel. Apidog deckt den gesamten API-Lebenszyklus ab, und der vollständige Leitfaden zur Apidog CLI zeigt die Terminalseite. Sie können Apidog herunterladen und eine Hoppscotch-Sammlung importieren, um direkt zu vergleichen, oder den Migrations-Walkthrough lesen.
FAQ
Ist die Hoppscotch CLI kostenlos? Ja. Sie ist Open Source unter dem Hoppscotch-Projekt, und Sie können das gesamte Ökosystem selbst hosten. Siehe die offiziellen CLI-Dokumente und das GitHub-Repo.
Was ist der Unterschied zwischen hopp test und Newman? Beide sind Sammlung-Runner mit datengesteuerten Iterationen. Newman führt Postman-Sammlungen aus; hopp test führt Hoppscotch-Sammlungen aus. Die Konzepte sind eng aufeinander abgestimmt, einschließlich CSV-Iterationsdaten und Pass/Fail basierend auf Exit-Codes.
Kann die Hoppscotch CLI Sammlungen von einem selbst gehosteten Server ausführen? Ja. Verwenden Sie hopp test <collection-id> --token <access_token> --server <your-url>, um eine Sammlung von Ihrer eigenen Instanz abzurufen und auszuführen.
Erzeugt sie HTML-Berichte? Nicht direkt. Sie schreibt JUnit XML über --reporter-junit. Für CLI-, HTML- und JSON-Berichte zusammen vergleichen Sie mit den Apidog CLI Testberichten.
Die Hoppscotch CLI ist eine saubere, kostenlose Möglichkeit, API-Sammlungen in CI auszuführen, insbesondere wenn Sie Hoppscotch bereits verwenden oder selbst hosten. Wenn Sie ihren Umfang kennen, Node v22 festlegen und sich auf die JUnit-Ausgabe verlassen, erledigt sie ihre eine Aufgabe gut.