Interview question
What are best practices for designing consistent JSON API responses? Consistent JSON API responses design करने की best practices क्या हैं?
Answer
A consistent response structure makes an API predictable and easier for consumers to parse, regardless of success or failure.
// Success response
{
"success": true,
"data": { "id": 1, "name": "John" },
"meta": { "page": 1, "total": 50 }
}
// Error response
{
"success": false,
"message": "Validation failed",
"errors": { "email": ["The email field is required."] }
}| Practice | Why it matters |
|---|---|
| Consistent envelope (success/data/errors) | Predictable parsing on client side |
| snake_case or camelCase consistently | Avoids confusion across endpoints |
| Never leak stack traces | Security - avoid exposing internals |
| Include pagination meta | Helps clients build UI navigation |
Consistent response structure API को predictable बनाता है और consumers के लिए parse करना आसान बनाता है।
// Success
{
"success": true,
"data": { "id": 1, "name": "John" }
}
// Error
{
"success": false,
"message": "Validation failed",
"errors": { "email": ["The email field is required."] }
}Was this answer clear?