API Interactive Documentation

Explore e teste as APIs interativamente usando o Swagger UI abaixo.

---

Ambientes

Staging

URL: https://api-staging.seuapp.com

Use este ambiente para: - Testar novas features - Integração de sistemas - Desenvolvimento local

Credenciais de teste: - Email: test@example.com - Password: TestPass123!

Production

URL: https://api.seuapp.com

⚠️ Atenção: Dados reais de clientes. Use com cuidado.

---

Como Usar

1. Autenticar

1. Clique em "POST /auth/login"
2. Clique em "Try it out"
3. Insira credenciais
4. Clique em "Execute"
5. Copie o access_token da resposta

2. Autorizar

1. Clique no botão "Authorize" (cadeado) no topo
2. Cole o token no campo "Value": Bearer <seu-token>
3. Clique em "Authorize"

3. Testar Endpoints

Agora todos os endpoints autenticados funcionarão!

1. Escolha um endpoint (ex: GET /api/v1/users/me)
2. Clique em "Try it out"
3. Clique em "Execute"
4. Veja a resposta

---

Autenticação

Todas as APIs requerem autenticação via JWT Token no header:

Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...

Ver guia completo de autenticação →

---

Documentação Adicional

• API Reference - Overview das APIs
• Architecture: API Design - Padrões e convenções
• Testing APIs - Como testar

---

Nota

Esta documentação é gerada automaticamente do código FastAPI.

Para atualizar:

python scripts/export_openapi.py

Última atualização: Gerada automaticamente no build do MkDocs