Resterm

Un atelier API-as-code pour le terminal.
resterm.app · docs

Resterm est un client API qui utilise les fichiers .http/.rest comme code source. La quasi-totalité des fonctionnalités réside dans les fichiers .http, ce qui les rend faciles à relire dans Git ou tout autre système de gestion de versions. Vous pouvez envoyer des requêtes, tester des flux API, enregistrer le trafic HTTP et lancer des serveurs mock locaux directement depuis l'interface TUI, ou exécuter les mêmes définitions dans des scripts et en CI avec la commande resterm run.

Pourquoi Resterm

• Testez des flux API complets. Connectez-vous, capturez un token, créez une ressource et vérifiez le résultat. Ajoutez des assertions, des boucles, des conditions, des retries et des scripts directement dans vos fichiers de requêtes.
• Transformez le trafic réel en mocks locaux. Enregistrez les requêtes et réponses HTTP, puis sauvegardez-les comme requêtes exécutables ou définitions de mocks. Gardez les mocks à côté des requêtes qui les utilisent.
• Découvrez ce qui a changé. Comparez les réponses entre environnements, différez par rapport aux résultats précédents, inspectez les temps de requête et profilez les exécutions répétées.
• Exécutez les mêmes vérifications en local et en CI. Utilisez l'interface terminal pendant le développement, puis exécutez ces fichiers avec resterm run. Exportez des rapports JSON ou JUnit.
• Travaillez avec plusieurs protocoles. Envoyez des requêtes HTTP, GraphQL et gRPC, et travaillez avec des flux WebSocket et SSE.

Les tunnels SSH et les port-forwards Kubernetes intégrés vous permettent d'atteindre des API derrière un bastion ou à l'intérieur d'un cluster.

Pas de compte, pas de télémétrie, pas de fonctionnalités d'IA.

Captures d'écran

Trace et chronologie

Cliquez pour voir plus de l'interface

Workflows

Profileur

Explain

RestermScript

Installation

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

Avec Go 1.25 ou plus récent :

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

Des binaires précompilés pour macOS, Linux et Windows sont disponibles sur la page des releases. Les binaires Linux nécessitent glibc 2.32 ou plus récent.

Pour mettre à jour, exécutez brew upgrade resterm si vous avez installé avec Homebrew. Sinon, exécutez resterm --update. Plus d'informations dans le guide d'installation.

Démarrage rapide

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

resterm init crée un fichier requests.http avec quelques requêtes d'exemple et des mocks locaux pour y répondre, afin que vous n'ayez pas besoin d'une vraie API pour l'essayer. Appuyez sur g Shift+M pour démarrer le serveur mock, déplacez le curseur sur une requête et appuyez sur Ctrl+Enter pour l'envoyer. Appuyez sur ? pour obtenir de l'aide à tout moment.

Vous n'avez pas non plus besoin de init. Lancez resterm, saisissez une URL ou collez une commande curl, puis appuyez sur Ctrl+Enter.

Le même fichier s'exécute également sans l'interface. Démarrez les mocks dans un terminal et exécutez une requête dans un autre :

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

Fichiers de requêtes

Resterm lit le format standard .http et ajoute des directives # @ par-dessus pour les paramètres et l'automatisation :

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

Un @setting placé avant la première requête s'applique à l'ensemble du fichier. ### démarre une nouvelle requête. Les directives au-dessus d'une requête peuvent la répéter, la sauter ou vérifier la réponse.

D'autres exemples sont disponibles dans _examples/, et chaque directive est listée dans la référence des fichiers de requêtes.

Documentation

La documentation complète se trouve sur resterm.app/docs. De bons points de départ sont workflows, serveurs mock, enregistrement, la CLI et RestermScript.

Dans l'interface TUI, :help <topic> ouvre le manuel intégré et :docs <topic> ouvre la même page sur le site web.

Pour exécuter des fichiers de requêtes depuis votre propre code Go, consultez le paquet headless.

Sponsor

Resterm est et restera toujours gratuit et open source. Si vous aimez mon travail, vous pouvez le sponsoriser sur GitHub.

Licence

Apache License 2.0.