elsewhencode / elsewhencode/project-guidelines

Consistent API error messages

Ouverte
#134 0 commentaires 0 réactions 1 personne assignée Réclamée par @vpanjganj Voir sur GitHub
improvement question
Langage dominant
JavaScript
Étoiles
29.4k
Forks
3.1k
Métriques de merge des PR
Aucune PR mergée en 30 j

Description

Hello,

Recently we discussed in the Topcoder Community, and people have different opinions regarding errors messages.

From your best practices:

> Response messages must be self-descriptive. A good error message response might look something like this:
```
// (1)
{
"code": 1234,
"message" : "Something bad happened",
"description" : "More details"
}
```
> or for validation errors:
```
// (2)
{
"code" : 2314,
"message" : "Validation Failed",
"errors" : [
{
"code" : 1233,
"field" : "email",
"message" : "Invalid email"
},
{
"code" : 1234,
"field" : "password",
"message" : "No password provided"
}
]
}
```

Based on my understanding, (1) schema can be used as a general error format, and (2) schema can be used for a specific situation (validation errors in this case).
That means error responses don't have to have the exact format with the same properties.
Some developers insist that all error responses should be consistent and be the same.

Could you clarify it according to your best practices in this project?

Guide de contribution

Ouvrir le guide de contribution

Évaluation

Cette issue n'a pas encore été évaluée.

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.