Zapi
GitHub Télécharger

Démarrer

Documentation Zapi

Le guide complet pour organiser des collections YAML, envoyer des requêtes, écrire des tests, automatiser en CI et publier ton API.

# Pourquoi Zapi

Zapi est un client API desktop local-first. Tes collections sont des fichiers YAML lisibles et versionnables, tes secrets restent dans le keychain de l’OS, et les mêmes scripts QuickJS tournent dans l’app comme dans la CLI. Aucun compte, aucun cloud requis.

  • REST, GraphQL, WebSocket, SSE et gRPC dynamique dans un même flux de travail.
  • Scripts preRequest et tests avec test(), expect(), console et zapi.fetch().
  • Runner de collection avec rapports JSON / JUnit, option --bail et codes de sortie CI.
  • Historique local SQLite et export OpenAPI 3.1 généré depuis les collections.

# Parcours recommandé

  1. Installe Zapi depuis les releases GitHub, puis ouvre ou crée un dossier de collection.
  2. Crée un environnement avec baseUrl et garde les valeurs sensibles via {{secret:NOM}}.
  3. Décris chaque endpoint dans requests/*.yml, ajoute des scripts et des tests.
  4. Lance le runner dans l’app, puis branche la CLI dans ta CI pour publier des rapports.
Structure minimale 
ma-collection/
├─ collection.yml
├─ environments/
│  ├─ local.env.yml
│  └─ staging.env.yml
└─ requests/
   ├─ 01-login.yml
   ├─ 02-get-user.yml
   └─ 03-live-events.yml

# Cartographie des guides

GuideÀ lire quand
Prise en mainTu veux une première collection fonctionnelle en quelques minutes.
ConceptsTu veux comprendre le format de dossier et l’ordre de résolution.
Variables & secretsTu veux chaîner des valeurs et garder tes secrets hors du repo.
Scripts & testsTu veux automatiser de l’auth et écrire des assertions.
Runner & CITu veux exécuter une collection sans interface et produire des rapports.
RéférenceTu veux vérifier un champ YAML, une option CLI ou un raccourci.