Gaia: Глобальный оценщик целостности API

Зависимости

• Установите opam для сборки тестового API.

• Установите git, python3, pip и .NET для сборки RESTler и Schemathesis.

• Установите cargo для сборки Gaia.

• Установите docker v26.0.1 и docker compose v2.26.1 для сборки Gaia с ELK Stack (необязательно, если не требуется).

• Установите node >= v18.0.0 и npm >= v8.6.0

• Чтобы создать локальный переключатель opam:

make opam-switch

• Чтобы установить все зависимости:

make deps

Сборка

• Чтобы собрать Gaia:

make build

• Чтобы собрать тестовое API:

make build-test

Спецификация OpenAPI

• Чтобы сгенерировать спецификацию OpenAPI для тестов:

make generate-swagger

• Чтобы удалить спецификацию OpenAPI для тестов:

make clean-swagger

Форматирование

• Чтобы отформатировать проект (тест + исходный код):

make format

Очистка

• Чтобы очистить файлы сборки (тест + исходный код):

make clean-build-files

• Чтобы очистить всё:

make clean

Выполнение

• После сборки вы можете отобразить опции GAIA с помощью:

./_bin/gaia --help

• Использование GAIA:

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

• workdir-path: Рабочая директория, в которой вы найдете различные журналы фаззеров.

• openapi-path: Путь к файлу OpenAPI реального API. Требуется при использовании фаззинга или мониторинга, но не для статистики

• verbose : Уровень детализации {NOTHING, LOW, MID, HIGH, ALL} (Значение по умолчанию: NOTHING)

• configuration: Путь к JSON-файлу, который содержит: