Gaia: Global API Integrity Assessor

Dependencies

• Install opam to build the tests API.

• Install git, python3, pip and .NET to build RESTler and Schemathesis.

• Install cargo to build Gaia.

• Install docker v26.0.1 and docker compose v2.26.1 to build Gaia with the ELK Stack (optionnal if not).

• Install node >= v18.0.0 and npm >= v8.6.0

• To create an opam local switch:

make opam-switch

• To install all dependencies:

make deps

Build

• To build Gaia:

make build

• To build the tests API:

make build-test

OpenAPI Specification

• To generate the OpenAPI specification for the tests:

make generate-swagger

• To remove the OpenAPI specification for the tests:

make clean-swagger

Formatting

• To format the project (test + source):

make format

Clean

• To clean the build files (test + source):

make clean-build-files

• To clean everything:

make clean

Execution

• After building, you can display GAIA options by:

./_bin/gaia --help

• GAIA usage:

gaia --configuration <configuration> --openapi-path <openapi-path> --workdir-path <workdir-path> --verbose <verbose>

• workdir-path: The working directory where you will find the different logs of the fuzzers.

• openapi-path: Path file of the OpenAPI file of the real API. Required when you use fuzzing or monitoring but not for statistics

• verbose : The level of verbosity {NOTHING, LOW, MID, HIGH, ALL} (Default value : NOTHING)

• configuration: The path of the json file that contains :