Repository navigation
API REST
Bruno edited this page Aug 16, 2026
·
1 revision
| Método | Rota | Descrição |
|---|---|---|
| GET | /api/health |
healthcheck |
| GET | /api/tools |
categorias + catálogo completo (com perguntas) |
| GET | /api/tools/{id} |
detalhe de uma ferramenta |
| POST | /api/generate |
gera comandos a partir das respostas |
| GET | / |
frontend SPA |
curl -s -X POST http://localhost:8080/api/generate \
-H 'Content-Type: application/json' \
-d '{
"toolId": "nmap",
"answers": {
"targets": "10.10.10.0/24",
"scanType": "aggr",
"verbose": "true"
}
}'Resposta:
{
"toolId": "nmap",
"toolName": "Nmap",
"risk": "medium",
"commands": [
{ "title": "Varredura principal", "language": "shell",
"code": "nmap -A -vv 10.10.10.0/24", "hint": "…" }
],
"notes": ["…"],
"warnings": ["Varredura de redes sem autorização é ilegal…"]
}| Campo | Tipo | Descrição |
|---|---|---|
toolId |
string | Identificador da ferramenta. |
toolName |
string | Nome de exibição da ferramenta. |
risk |
string | Nível de risco (low, medium, high). |
commands |
array | Lista de comandos (title, language, code, hint). |
notes |
array | Notas complementares. |
warnings |
array | Alertas de risco/legalidade. |