2010-12-03 6 views
0

私はREST APIを構築し、xml表現にどのような形式を使用するべきか議論しています。 私はそれが自宅で定義されることができることは知っていますが、フォーマットのための多くがあります。 wadlは興味深いようですが、それについての議論があるようであり、それも新しいです。xmlのREST表現

推奨事項(ベストプラクティス)は何ですか?

答えて

0

有効なXMLであれば、始まりです。単純なREST/XMLサービスの私の一般的な戦略は以下の通りです:

構文解析には、常に、常に存在する単一のルートノードが必要です。 "応答"は、結果要素またはエラー要素のいずれかを含むことができます。あなたは結果を構造化 例えば:

<response> 
    <result> 
    <answer>5</answer> 
    </result> 
</response> 

方法は、あなた次第です。あなたは、CDATA(上の図のようなテキストノート)として、または必要な属性として、エレメートにデータを保持するかどうかを決めることができます。

<answer value="5"/> 

と便利な場合がありますもう一つは、例えば、反応して、あなたの元のクエリを含めることです。:

<response query="operation=add&a=2&b=3"> .. </response> 

こうすることで、あなたが優れた複数のクエリを持っている場合は、元の要求にそれらを一致させることができます。

+0

はい有効なxmlです。これは必須です。 – silviud

+0

私の質問はより関連しています - あなたが描くように私自身の方法を発明し、おそらくRESTの利点の一部を省略するか、またはよく知られている表現を使用する危険性があります。 – silviud

+0

WADLの記述は、あなたのRESTサービスを正式に記述する方法ですが、XML応答形式は依然として定義してからWADL応答表現で記述するものです。あなたのサービスが簡単でない限り、例えば。文字通り名前のリソースにテキストを投稿したり、名前のリソースからテキストを読み取ったりする場合は、通常、データのフォーマットを作成する必要があります。 – andrewmu