NestJS Fastify Starter Kit
API Response

API Response

All endpoints return a consistent response envelope.

Success Payload

{
  "success": true,
  "statusCode": 200,
  "message": "OK",
  "path": "/health",
  "data": {
    "status": "ok"
  }
}

Error Payload

{
  "success": false,
  "statusCode": 404,
  "message": "Cannot GET /unknown-route",
  "error": {
    "message": "Cannot GET /unknown-route",
    "error": "Not Found",
    "statusCode": 404
  },
  "path": "/unknown-route"
}

Endpoints

MethodPathDescription
GET/API root
GET/healthHealth check
GET/docsSwagger UI