API JSON Responses 📄

This document outlines the structure and conventions of JSON responses returned by our API. Understanding these patterns will help you interpret data effectively.

Success Response 🎉

On successful API calls, responses follow this format:

{
  "status": "success",
  "data": { ... },
  "message": "Operation completed successfully"
}

📌 Example:

{
  "status": "success",
  "data": {
    "id": 123,
    "name": "Example Resource"
  },
  "message": "Resource retrieved"
}

Error Response 💥

Error responses include detailed error information:

{
  "status": "error",
  "code": 404,
  "message": "Resource not found",
  "details": { ... }
}

📌 Example:

{
  "status": "error",
  "code": 400,
  "message": "Invalid request parameters",
  "details": {
    "field": "username",
    "issue": "Must be at least 3 characters"
  }
}

Pagination & Metadata 🧾

For paginated results, metadata is included:

{
  "data": [...],
  "pagination": {
    "page": 1,
    "per_page": 10,
    "total_pages": 5
  }
}

🔗 了解更多 about API conventions.