Medium
Api
Return consistent error responses
Official
Rule Description
Use a consistent error response format across all endpoints:
```json
{
"error": {
"code": "validation_error",
"message": "Validation failed",
"details": [
{ "field": "email", "message": "is invalid" },
{ "field": "name", "message": "can't be blank" }
]
}
}
```
Include:
- Machine-readable error code
- Human-readable message
- Field-level details for validation errors
Included in Rulesets
Add This Rule
Sign in to add this rule to your workspace
Sign in with GitHubDetails
- Severity
- Medium
- Category
- Api
- Used in
- 6 rulesets