API Overview

DevPortal ships with a JSON API layer built on the same routing engine — no separate framework needed.

Base URL

https://your-app.com/api/v1/

Response Format

All API responses follow a consistent envelope:

{
  "success": true,
  "data": { ... },
  "meta": {
    "page": 1,
    "per_page": 20,
    "total": 142
  }
}

Errors return a non-2xx status with:

{
  "success": false,
  "error": {
    "code": "VALIDATION_FAILED",
    "message": "The email field is required.",
    "fields": { "email": ["required"] }
  }
}

Versioning

API versions are URI-prefixed (/api/v1/, /api/v2/). Old versions stay alive until a deprecation notice is issued with a 30-day sunset window.