Medium Api

Return consistent error responses

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

Rails Standards
36 rules • 1 standard
View
Django Best Practices
36 rules • 1 standard
View
FastAPI Guidelines
36 rules • 1 standard
View
Express Standards
31 rules • 1 standard
View
Spring Boot Standards
24 rules • 2 standards
View
Code Review Standards
58 rules • 0 standards
View

Add This Rule

Sign in to add this rule to your workspace

Sign in with GitHub

Details

Severity
Medium
Category
Api
Used in
6 rulesets