Health e meta

Rotas públicas de metadados e liveness. Sem Bearer.

Catálogo: catalogo-completo.md §1.

GET /api

Controller: AppController
Auth: pública

{
  "name": "CentralCRM API",
  "version": "1.0.0",
  "docs": "/api/health",
  "swagger": "/api/docs"
}

Nota: o campo docs aponta para o health, não para o Swagger. A UI OpenAPI está em swagger / /api/docs.

GET /api/health

Controller: HealthController → HealthService.check()
Auth: pública
Tag Swagger: Saúde

Implementação actual: liveness apenas — devolve { status: "ok", timestamp } sem ping às BDs. Um 200 não prova que o PostgreSQL está acessível.

HTTP	Significado
200	Processo a responder
5xx / timeout	Processo em baixo ou proxy

Usado pelo healthcheck do Docker Compose. Diagnóstico de BD: runbooks/postgres.md.

OpenAPI

Path	Formato
GET /api/docs	Swagger UI
GET /api/docs-json	JSON
GET /api/docs-yaml	YAML