Restful API呼び出しに対するJSON応答のベストプラクティス？

Question

私は、Restful API呼び出しのためのJSON応答を返すためのベストプラクティスを確認しようとしています。私は異なる意見を提供する複数のブログやチュートリアルの記事を読んだ。

// response to a GET that returns an array of elements 

{ 
    "status": "success", 
    "count": 2, 
    "type": "LoadServingEntity", 
    "results":[ { 
     "lseId": 2756, 
     "name":"Georgia Power Co", 
     "code":"7140", 
     "websiteHome":"http://www.georgiapower.com/" 
    }, { 
     "lseId":1, 
     "name":"City of Augusta", 
     "code":"1000", 
     "websiteHome":null 
    }] 
} 

// an response that reports an API error 

{ 
    "status":"error", 
    "count":2, 
    "type":"Error", 
    "results":[{ 
     "code":"NotNull", 
     "message":"An appKey must be supplied", 
     "objectName":"requestSignature", 
     "propertyName":"appKey" 
    }, { 
     "code":"NotNull", 
     "message":"An appId must be supplied", 
     "objectName":"requestSignature", 
     "propertyName":"appId" 
    }] 
} 

その他の記事うんち-うんちこのアプローチを：私が見た

一つのアプローチは、表現は、以下に示すように任意のRESTfulな呼び出しは、メタデータ、および結果データの両方を含んでJSONレスポンスを返すことを提案しています。私は新しいAPIプロジェクトを開始しようとしています。このテーマに関する最善のアプローチについて、専門家からのフィードバックを得たいと思います。

TIA

Answer 1

JSON APIを構築するための推奨仕様を提供http://jsonapi.org/をチェックしてください。応答にはデータとメタデータの両方が含まれている必要があります