Formats de fichiers

.restorm — le projet

Le fichier de projet. YAML par défaut ; les formats json et json5 sont également pris en charge.

Il contient l’arbre complet — dossiers, dossiers de variables, requêtes, scénarios — les environnements et leurs variables, les listes de valeurs personnalisées, les énumérations, les tags et leurs couleurs, la documentation d’API, les paramètres rapides de portée « projet », un identifiant de projet et une version de format.

À commiter. Voir Projets et fichiers .restorm.

Mode dossier

Le même contenu, éclaté sur le disque :

Fichier	Rôle
restorm.conf	Configuration minimale à la racine : format: yaml | json | json5
index.yaml (ou .yml, .json, .json5)	Un index par répertoire
<index> - <nom>/	Les dossiers, préfixés d’un index à zéros de tête

Les caractères interdits par les systèmes de fichiers (<>:"/\|?*) sont remplacés par _, et les noms sont tronqués à 100 caractères.

À commiter.

.restorm/settings.json

Les réglages d’espace de travail, dans un sous-dossier du répertoire du projet. Un JSON creux : seules les clés surchargées y figurent.

À commiter si vous voulez imposer des réglages à l’équipe.

<projet>.responses.zip

L’archive de l’historique des réponses et des exécutions de scénarios, posée à côté du projet.

À ne pas commiter — ajoutez-la au .gitignore. Elle grossit vite et peut contenir des données de réponse.

restorm.env

Le fichier de secrets local, à côté du projet.

À ne jamais commiter.

.gitignore recommandé

# Historique des réponses et des runs Restorm
*.responses.zip

# Secrets locaux Restorm
restorm.env

Formats importés

Restorm lit vingt-quatre formats d’import supplémentaires. Voir Importer une API.