elsewhencode / elsewhencode/project-guidelines

Consistent API error messages

オープン
#134 コメント 0 件 リアクション 0 件 担当者 1 名 @vpanjganj が担当を希望しています GitHub で見る
improvement question
主要言語
JavaScript
スター
29.4k
フォーク
3.1k
PR マージ指標
30日以内にマージされた PR はありません

説明

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?

コントリビューションガイド

コントリビューションガイドを開く

評価

この issue はまだ評価されていません。

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。