Gaia: Evaluador Global de Integridad de API

Dependencias

• Instalar opam para compilar la API de pruebas.

• Instalar git, python3, pip y .NET para compilar RESTler y Schemathesis.

• Instalar cargo para compilar Gaia.

• Instalar docker v26.0.1 y docker compose v2.26.1 para compilar Gaia con ELK Stack (opcional si no se usa).

• Instalar node >= v18.0.0 y npm >= v8.6.0

• Para crear un conmutador local de opam:

make opam-switch

• Para instalar todas las dependencias:

make deps

Compilación

• Para compilar Gaia:

make build

• Para compilar la API de pruebas:

make build-test

Especificación OpenAPI

• Para generar la especificación OpenAPI para las pruebas:

make generate-swagger

• Para eliminar la especificación OpenAPI de las pruebas:

make clean-swagger

Formateo

• Para formatear el proyecto (prueba + fuente):

make format

Limpieza

• Para limpiar los archivos de compilación (prueba + fuente):

make clean-build-files

• Para limpiar todo:

make clean

Ejecución

• Después de compilar, puede mostrar las opciones de GAIA con:

./_bin/gaia --help

• Uso de GAIA:

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

• workdir-path: El directorio de trabajo donde encontrará los diferentes registros de los fuzzers.

• openapi-path: Ruta del archivo OpenAPI de la API real. Requerido cuando se usa fuzzing o monitoreo, pero no para estadísticas

• verbose: El nivel de verbosidad {NOTHING, LOW, MID, HIGH, ALL} (Valor por defecto: NOTHING)

• configuration: La ruta del archivo json que contiene: