1

私は REST API を設計しており、この問題に遭遇しました:

一連の値をどのように定義する必要がありますか?

http://myserver.com/api/getPicture/1で要求される Picture オブジェクトがあるとします。

したがって、サーバーは次のように応答します。

{
 url : "http://myserver.com/pictures/1.jpg",
 taken_at : "1/1/2012"
}

ここで、color_depth フィールドを追加したいとします。

これを行うには、次の 2 つの選択肢があります。

color_depth : "BLACK_WHITE" or "COLOR" or "GRAYSCALE"
color_depth : "0" OR "1" OR "2" //would need to map these to their meaning somewhere

この状況で何をすべきかについての標準はありますか？

4

1 に答える 1

4

JSON には、デファクトまたは公式の標準はありません。JSON-SCHEMAはこれを解決しようとしていますが、仕様はまだ推奨されておらず、実装も一般的ではありません。

XML を使用すると、XML スキーマが標準的なソリューションになります。RDF には、この問題を解決する RDFS もあります。

すべてのフォーマットについて、アイデアはあなたのものです。整数識別子 (1、2、3) に依存し、それらをスキーマなしで変換するということは、リクエストが「COLOR」のように意味を表す文字列よりもはるかに自己完結型ではないことを意味します。リクエストが自己完結型であることは、RESTful API 設計の中心的な概念です。これは、Roy Fielding の論文で説明されている RESTful アーキテクチャの可視性プロパティに大まかに関連しています。

私は完全な文字列に行きます。

于 2012-06-26T17:42:46.427 に答える