成功の JSON、失敗の JSON、エラーの JSON を返す標準形式は何ですか? 私は多くのいわゆる RESTful API を訪問しましたが、ほとんどすべてが成功、失敗、およびエラーの JSON を返す独自の方法を持っていますか? 従う/参照する必要がある推奨される JSON 形式はありますか?
ありがとう
良い質問。REST にはいくつかの規則が設定されていますが、送信されるタグ名に少なくとも規則がある GET または PUT HTML とは異なり、JSON に使用される語彙についてはほとんどありません。 HTML、XMPP、JSON の方言など、基本的なトランザクション動作を超えた正式な語彙を開発する必要があります (たとえば、XMPP では、WebSocket だけとは異なり、任意の Pubsub サーバーのサブスクリプションとパブリッシュを処理する方法を知っているクライアントを開発できます)。 .
説明に従ってHTTP ステータス コードに従う必要があります。すべての REST 失敗/エラー レスポンスに、errorCode
や などの一般的なフィールドを用意しておくとよいでしょerrorMessage
う。
{
"apiStatus":{
"errorCode":"validation.error.invalidId",
"errorMessage":"The Id entered is not valid"
}
"yourContentIfany": ....
}
成功、エラー、またはその他のステータスを通知するには、標準の http ステータス コードを使用する必要があります。エラーが発生した場合は、コード、重大度、メッセージなどを含む json を返すこともできます。