Swagger - acnscoelho/ppp-gestao-gastos-domesticos-api GitHub Wiki

O Swagger é uma ferramenta de documentação interativa da API que permite visualizar e testar todos os endpoints diretamente no navegador.

🔗 Acesso

URL: http://localhost:3000/api-docs

⚠️ Importante: O servidor deve estar em execução para acessar o Swagger

🚀 Como Usar

1. Acessar o Swagger

  • Abra o navegador
  • Acesse http://localhost:3000/api-docs

2. Explorar Endpoints

  • Navegue pelas categorias (Users, Expenses, Revenues, etc.)
  • Clique em cada endpoint para ver detalhes

3. Testar Endpoints

Endpoints Públicos (sem autenticação)

  1. Clique em Try it out
  2. Preencha os parâmetros
  3. Clique em Execute
  4. Veja a resposta

Endpoints Protegidos (com autenticação)

  1. Faça login em /api/users/login
  2. Copie o token retornado
  3. Clique no botão Authorize (cadeado)
  4. Cole o token no formato: Bearer {seu_token}
  5. Clique em Authorize
  6. Agora você pode testar endpoints protegidos

📋 Endpoints Disponíveis

👤 Users

  • POST /api/users/register - Registrar usuário
  • POST /api/users/login - Fazer login
  • GET /api/users/profile - Ver perfil 🔒
  • PUT /api/users/profile - Atualizar perfil 🔒
  • DELETE /api/users/profile - Deletar conta 🔒

💸 Expenses

  • POST /api/expenses/fixed - Criar despesa fixa 🔒
  • GET /api/expenses/fixed - Listar despesas fixas
  • POST /api/expenses/variable - Criar despesa variável 🔒
  • GET /api/expenses/variable - Listar despesas variáveis
  • POST /api/expenses/payment - Processar pagamento 🔒
  • GET /api/expenses/summary - Resumo financeiro

💰 Revenues

  • POST /api/revenues - Criar receita 🔒
  • GET /api/revenues - Ver minha receita 🔒
  • PUT /api/revenues - Atualizar receita 🔒
  • DELETE /api/revenues - Deletar receita 🔒

💳 Payments

  • GET /api/payments - Listar pagamentos
  • GET /api/payments/summary - Resumo de pagamentos
  • DELETE /api/payments/:id - Deletar pagamento 🔒

📊 Dashboard

  • GET /api/dashboard - Dashboard visual (HTML)
  • GET /api/dashboard/data - Dados do dashboard (JSON)

🔒 = Requer autenticação

💡 Dicas

  • Use o Swagger para entender a estrutura dos payloads
  • Teste cenários de sucesso e erro
  • Verifique os exemplos de requisição e resposta
  • Use para criar casos de teste