Pular para o conteúdo principal

Referência da API

A API é API-first: o contrato OpenAPI é gerado automaticamente pelo NestJS (@nestjs/swagger) e renderizado com Scalar.

  • Scalar embutido nesta doc: /api-reference
  • Scalar servido pela API (canônico): http://localhost:3001/reference
  • OpenAPI bruto (JSON): http://localhost:3001/openapi.json

Regra de manutenção​

Todo endpoint novo/alterado deve ter os decorators de documentação (@ApiTags, @ApiOperation, DTOs com @ApiProperty, respostas/erros) no mesmo PR. Um endpoint que não aparece no Scalar é considerado incompleto.

Autenticação na referência​

Use o botão Authorize e informe o accessToken (Bearer) obtido em POST /api/auth/login para testar as rotas protegidas.