Gaia : Évaluateur mondial de l'intégrité des API

Dépendances

• Installez opam pour construire l'API de tests.

• Installez git, python3, pip et .NET pour construire RESTler et Schemathesis.

• Installez cargo pour construire Gaia.

• Installez docker v26.0.1 et docker compose v2.26.1 pour construire Gaia avec la pile ELK (optionnel sinon).

• Installez node >= v18.0.0 et npm >= v8.6.0

• Pour créer un switch local opam :

make opam-switch

• Pour installer toutes les dépendances :

make deps

Compilation

• Pour compiler Gaia :

make build

• Pour compiler l'API de tests :

make build-test

Spécification OpenAPI

• Pour générer la spécification OpenAPI pour les tests :

make generate-swagger

• Pour supprimer la spécification OpenAPI pour les tests :

make clean-swagger

Formatage

• Pour formater le projet (tests + source) :

make format

Nettoyage

• Pour nettoyer les fichiers de compilation (tests + source) :

make clean-build-files

• Pour tout nettoyer :

make clean

Exécution

• Après la compilation, vous pouvez afficher les options de GAIA par :

./_bin/gaia --help

• Utilisation de GAIA :

gaia --configuration <configuration> --openapi-path <chemin-openapi> --workdir-path <chemin-répertoire-travail> --verbose <verbose>

• workdir-path : Le répertoire de travail où vous trouverez les différents journaux des fuzzers.

• openapi-path : Chemin du fichier OpenAPI de l'API réelle. Requis lorsque vous utilisez le fuzzing ou la surveillance mais pas pour les statistiques

• verbose : Le niveau de verbosité {NOTHING, LOW, MID, HIGH, ALL} (Valeur par défaut : NOTHING)

• configuration : Le chemin du fichier json qui contient :