Gaia: Avaliador de Integridade Global de API

Dependências

• Instale opam para construir a API de testes.

• Instale git, python3, pip e .NET para construir o RESTler e o Schemathesis.

• Instale cargo para construir o Gaia.

• Instale docker v26.0.1 e docker compose v2.26.1 para construir o Gaia com a ELK Stack (opcional caso contrário).

• Instale node >= v18.0.0 e npm >= v8.6.0

• Para criar um switch local do opam:

make opam-switch

• Para instalar todas as dependências:

make deps

Compilação

• Para compilar o Gaia:

make build

• Para compilar a API de testes:

make build-test

Especificação OpenAPI

• Para gerar a especificação OpenAPI para os testes:

make generate-swagger

• Para remover a especificação OpenAPI para os testes:

make clean-swagger

Formatação

• Para formatar o projeto (teste + fonte):

make format

Limpeza

• Para limpar os arquivos de compilação (teste + fonte):

make clean-build-files

• Para limpar tudo:

make clean

Execução

• Após a compilação, você pode exibir as opções do GAIA através de:

./_bin/gaia --help

• GAIA uso:

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

• workdir-path: O diretório de trabalho onde você encontrará os diferentes logs dos fuzzers.

• openapi-path: Caminho do arquivo OpenAPI da API real. Obrigatório quando você usa fuzzing ou monitoramento, mas não para estatísticas

• verbose : O nível de verbosidade {NOTHING, LOW, MID, HIGH, ALL} (Valor padrão: NOTHING)

• configuration: O caminho do arquivo json que contém :