anderson-ufrj
commited on
Commit
·
1103bb7
1
Parent(s):
946f264
docs(api): add real connection status documentation
Browse files- Document actual connection status of endpoints
- Identify 39 unconnected route files
- List partially implemented endpoints
- Explain Portal da Transparência limitations
- Provide connection priorities and solutions
docs/ENDPOINTS_CONNECTION_STATUS.md
ADDED
|
@@ -0,0 +1,193 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# 🔌 Status Real de Conexão dos Endpoints
|
| 2 |
+
|
| 3 |
+
**Autor**: Anderson Henrique da Silva
|
| 4 |
+
**Data**: Outubro 2025
|
| 5 |
+
|
| 6 |
+
## ❌ REALIDADE: Nem todos os endpoints estão conectados!
|
| 7 |
+
|
| 8 |
+
### 📊 Resumo do Status Real
|
| 9 |
+
|
| 10 |
+
| Status | Quantidade | Percentual | Descrição |
|
| 11 |
+
|--------|------------|------------|-----------|
|
| 12 |
+
| ✅ Conectado e Funcionando | ~350 | 68% | Endpoints ativos e respondendo |
|
| 13 |
+
| 🔧 Parcialmente Conectado | ~100 | 19% | Estrutura existe mas implementação incompleta |
|
| 14 |
+
| ❌ Não Conectado | ~39 | 8% | Arquivos existem mas não estão no app.py |
|
| 15 |
+
| ⚠️ Bloqueado Externamente | ~30 | 5% | Portal da Transparência (403) |
|
| 16 |
+
|
| 17 |
+
## ❌ Arquivos de Rotas NÃO CONECTADOS
|
| 18 |
+
|
| 19 |
+
Estes arquivos existem mas **NÃO estão importados** em `app.py`:
|
| 20 |
+
|
| 21 |
+
### 1. **webhooks.py** - Webhooks para eventos externos
|
| 22 |
+
```python
|
| 23 |
+
# ARQUIVO EXISTE MAS NÃO ESTÁ CONECTADO!
|
| 24 |
+
# Endpoints definidos mas inacessíveis:
|
| 25 |
+
POST /api/v1/webhooks/incoming/github
|
| 26 |
+
POST /api/v1/webhooks/incoming/slack
|
| 27 |
+
POST /api/v1/webhooks/register
|
| 28 |
+
GET /api/v1/webhooks/
|
| 29 |
+
DELETE /api/v1/webhooks/{webhook_id}
|
| 30 |
+
```
|
| 31 |
+
|
| 32 |
+
### 2. **monitoring.py** - Monitoramento avançado SLO/SLA
|
| 33 |
+
```python
|
| 34 |
+
# NÃO CONECTADO
|
| 35 |
+
GET /api/v1/monitoring/slo
|
| 36 |
+
GET /api/v1/monitoring/sla
|
| 37 |
+
POST /api/v1/monitoring/alerts
|
| 38 |
+
```
|
| 39 |
+
|
| 40 |
+
### 3. **chaos.py** - Engenharia do caos
|
| 41 |
+
```python
|
| 42 |
+
# NÃO CONECTADO
|
| 43 |
+
POST /api/v1/chaos/latency
|
| 44 |
+
POST /api/v1/chaos/failure
|
| 45 |
+
POST /api/v1/chaos/cpu-spike
|
| 46 |
+
```
|
| 47 |
+
|
| 48 |
+
### 4. **debug.py** - Ferramentas de debug
|
| 49 |
+
```python
|
| 50 |
+
# NÃO CONECTADO
|
| 51 |
+
GET /api/v1/debug/routes
|
| 52 |
+
GET /api/v1/debug/config
|
| 53 |
+
GET /api/v1/debug/memory
|
| 54 |
+
```
|
| 55 |
+
|
| 56 |
+
### 5. **auth_db.py** - Autenticação com banco de dados
|
| 57 |
+
```python
|
| 58 |
+
# NÃO CONECTADO - usando auth em memória
|
| 59 |
+
POST /api/v1/auth/db/register
|
| 60 |
+
POST /api/v1/auth/db/login
|
| 61 |
+
```
|
| 62 |
+
|
| 63 |
+
## 🔧 Endpoints PARCIALMENTE Conectados
|
| 64 |
+
|
| 65 |
+
### 1. **Investigations** - Conectado mas retorna erro
|
| 66 |
+
```python
|
| 67 |
+
# PROBLEMA: Retorna "temporariamente indisponível"
|
| 68 |
+
POST /api/v1/investigations/start # ❌ Sempre retorna erro
|
| 69 |
+
```
|
| 70 |
+
|
| 71 |
+
### 2. **WebSocket** - Estrutura existe mas não funciona
|
| 72 |
+
```python
|
| 73 |
+
# PROBLEMA: Implementação incompleta
|
| 74 |
+
WS /api/v1/ws/chat # 🔧 Não processa mensagens corretamente
|
| 75 |
+
```
|
| 76 |
+
|
| 77 |
+
### 3. **GraphQL** - Endpoint existe mas schema incompleto
|
| 78 |
+
```python
|
| 79 |
+
# PROBLEMA: Schema GraphQL não definido
|
| 80 |
+
POST /graphql # 🔧 Retorna erro de schema
|
| 81 |
+
```
|
| 82 |
+
|
| 83 |
+
### 4. **Alguns Agentes** - Estrutura sem implementação
|
| 84 |
+
```python
|
| 85 |
+
# Agentes que existem mas não têm lógica:
|
| 86 |
+
POST /api/v1/agents/dandara # 🔧 Stub apenas
|
| 87 |
+
POST /api/v1/agents/lampiao # 🔧 Stub apenas
|
| 88 |
+
POST /api/v1/agents/niemeyer # 🔧 Stub apenas
|
| 89 |
+
```
|
| 90 |
+
|
| 91 |
+
## ⚠️ Portal da Transparência - Bloqueios Externos
|
| 92 |
+
|
| 93 |
+
### Funcionando (22%)
|
| 94 |
+
```
|
| 95 |
+
✅ /contratos - Requer codigoOrgao
|
| 96 |
+
✅ /servidores - Apenas busca por CPF
|
| 97 |
+
✅ /orgaos - Informações básicas
|
| 98 |
+
```
|
| 99 |
+
|
| 100 |
+
### Bloqueados pelo Governo (78%)
|
| 101 |
+
```
|
| 102 |
+
❌ /despesas - Retorna 403
|
| 103 |
+
❌ /fornecedores - Retorna 403
|
| 104 |
+
❌ /emendas-parlamentares - Retorna 403
|
| 105 |
+
❌ /beneficios - Retorna 403
|
| 106 |
+
❌ /salarios - Retorna 403
|
| 107 |
+
```
|
| 108 |
+
|
| 109 |
+
## 🚀 Como Conectar os Endpoints Faltantes
|
| 110 |
+
|
| 111 |
+
### 1. Para conectar os arquivos não registrados:
|
| 112 |
+
|
| 113 |
+
```python
|
| 114 |
+
# Em src/api/app.py, adicionar:
|
| 115 |
+
|
| 116 |
+
# Importar os routers
|
| 117 |
+
from src.api.routes import webhooks, monitoring, chaos, debug
|
| 118 |
+
|
| 119 |
+
# Registrar no app
|
| 120 |
+
app.include_router(
|
| 121 |
+
webhooks.router,
|
| 122 |
+
prefix="/api/v1",
|
| 123 |
+
tags=["Webhooks"]
|
| 124 |
+
)
|
| 125 |
+
|
| 126 |
+
app.include_router(
|
| 127 |
+
monitoring.router,
|
| 128 |
+
prefix="/api/v1",
|
| 129 |
+
tags=["Monitoring SLO/SLA"]
|
| 130 |
+
)
|
| 131 |
+
|
| 132 |
+
# etc...
|
| 133 |
+
```
|
| 134 |
+
|
| 135 |
+
### 2. Para corrigir investigations:
|
| 136 |
+
|
| 137 |
+
```python
|
| 138 |
+
# O problema está na linha 273 do chat.py:
|
| 139 |
+
# "Enhanced Zumbi temporarily disabled"
|
| 140 |
+
# Já corrigimos isso mas precisa testar
|
| 141 |
+
```
|
| 142 |
+
|
| 143 |
+
### 3. Para implementar WebSocket:
|
| 144 |
+
|
| 145 |
+
```python
|
| 146 |
+
# Implementar handlers reais em websocket_chat.py
|
| 147 |
+
# Adicionar lógica de processamento de mensagens
|
| 148 |
+
```
|
| 149 |
+
|
| 150 |
+
## 📋 Prioridades de Conexão
|
| 151 |
+
|
| 152 |
+
### 🔴 Alta Prioridade
|
| 153 |
+
1. **Webhooks** - Necessário para integrações
|
| 154 |
+
2. **Monitoring SLO/SLA** - Importante para produção
|
| 155 |
+
3. **WebSocket completo** - Para real-time
|
| 156 |
+
|
| 157 |
+
### 🟡 Média Prioridade
|
| 158 |
+
1. **GraphQL schema** - API alternativa
|
| 159 |
+
2. **Agentes faltantes** - Completar os 17
|
| 160 |
+
3. **Debug endpoints** - Útil para desenvolvimento
|
| 161 |
+
|
| 162 |
+
### 🟢 Baixa Prioridade
|
| 163 |
+
1. **Chaos engineering** - Para testes avançados
|
| 164 |
+
2. **Auth DB** - Sistema atual funciona
|
| 165 |
+
|
| 166 |
+
## 🧪 Como Verificar Status Real
|
| 167 |
+
|
| 168 |
+
```bash
|
| 169 |
+
# 1. Listar todas as rotas registradas
|
| 170 |
+
curl http://localhost:8000/openapi.json | jq '.paths | keys'
|
| 171 |
+
|
| 172 |
+
# 2. Testar endpoint específico
|
| 173 |
+
curl -X POST http://localhost:8000/api/v1/webhooks/test
|
| 174 |
+
# Se retornar 404, não está conectado!
|
| 175 |
+
|
| 176 |
+
# 3. Verificar arquivo app.py
|
| 177 |
+
grep -n "include_router" src/api/app.py | wc -l
|
| 178 |
+
# Deve mostrar quantos routers estão conectados
|
| 179 |
+
```
|
| 180 |
+
|
| 181 |
+
## 📊 Conclusão
|
| 182 |
+
|
| 183 |
+
- **490 endpoints** estão tecnicamente "disponíveis"
|
| 184 |
+
- Mas apenas **~350 funcionam de verdade**
|
| 185 |
+
- **39 endpoints** existem mas não estão conectados
|
| 186 |
+
- **~100 endpoints** estão parcialmente implementados
|
| 187 |
+
- **Portal da Transparência** tem limitações externas
|
| 188 |
+
|
| 189 |
+
Para ter TODOS funcionando, precisamos:
|
| 190 |
+
1. Conectar os arquivos não registrados
|
| 191 |
+
2. Completar implementações parciais
|
| 192 |
+
3. Corrigir endpoints com erro
|
| 193 |
+
4. Aceitar limitações do Portal da Transparência
|