HTTP GETの複数のKey-ValueパラメータのREST URIを設計する方法

Question

私はRESTful APIを設計しています。

1つのサービスは、複数のキーと値のペアに対してクエリ機能を提供する必要があります。たとえば、クライアントは、異なる製品および関連する数量に対して1つのHTTP GET要求を照会することができます。私は知らないので

/produkt?productId1=1&productquantity1=44&productId2=2&productquantity2=55 

：クライアントは、私は実際に私のURIは次のようになりたくない量55 と量44と製品2と製品1を照会したい

クエリされる商品の数。

またはこのような：

/produkt?product=1,44&product=2,55 

どのようにクライアントがカンマの前のProductIDとカンマの後の数量があることを知ることができるからです。

他に解決策がありますか？または、1つのリクエストで複数の製品を照会する可能性を提供することは、RESTfulではありませんか？関連する数量を持つ1つの製品だけを照会する可能性を提供する方が良いでしょうか？クライアントがより多くの製品を照会したい場合は、より多くの要求を送信する必要がありますか？

Answer 1

注文の内容が^*ではないため、製品の部分に明示的な名前を追加し、コンマの代わりにセミコロンを使用することで、2番目の提案を少し拡大します。

/products?id=1;qty=44&qty=55;id=2 

属性の順序は重要ではありませんので、idとqtyは、第二製品の周りに切り替えられるかに注意してください。

---

^*は、順序が重要でないときの順序が重要であり、セミコロンするときにコンマを使用する慣習があります。ここで

Answer 2

は、パラメータを渡すために1つのアイデアです：

[{"key":"key0","value":"key1"},{"key":"key2","value":"key2"},{"key":"key3","value":"key3"}] 

はそうあなたが簡単にクエリパラメータを変換することができList<kv>クラス

class kv { 
    String key; 
    String value; 


    public kv(String key, String value) { 
     super(); 
     this.key = key; 
     this.value = value; 
    } 

    public String getKey() { 
     return key; 
    } 

    public void setKey(String key) { 
     this.key = key; 
    } 

    public String getValue() { 
     return value; 
    } 

    public void setValue(String value) { 
     this.value = value; 
    } 

} 

のJSON表現です

/products?productDetail=[{"key":"key0","value":"key1"},{"key":"key2","value":"key2"},{"key":"key3","value":"key3"}] 

productDetailからList<kv>まで

new Gson().fromJson(productDetail,kv.class); 

あなたは簡単にすべての要素を反復することができます。

もう1つの提案は、クエリされた商品の数がわからない場合は、POST要求を使用することです。