Jak zaprojektować REST URI dla wielu par klucz-wartość HTTP GET

Question

Projektuję RESTful API.

Jedna usługa powinna oferować funkcję zapytań dla wielu par klucz-wartość. Na przykład klient może wysłać zapytanie za pomocą jednego żądania HTTP GET dla różnych produktów i związanej z nimi ilości.

Klient chce zapytać produkt 1 z kwotą 44 i produktu 2 z kwotą 55. I rzeczywiście nie ma moja URI wyglądać następująco:

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

bo nie wiem ile produktów jest zapytanych.

Albo tak:

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

bo jak można klient wie, że przed przecinkiem nie jest productId i po przecinku liczbę zdjęć.

Czy ktoś ma inne rozwiązania? Czy też nie jest RESTful oferować możliwość wysyłania zapytań do wielu produktów za jednym razem? Czy lepiej jest oferować możliwość odpytywania tylko jednego produktu z powiązaną ilością, a jeśli klient chce zapytać o więcej produktów, powinien wysłać więcej wniosków?

Answer 1

Chciałbym rozwinąć nieco drugą sugestię, dodając wyraźne nazwy części produktu i używając średników zamiast przecinków, aby oddzielić atrybuty produktu, ponieważ zamówienie nie ma znaczenia ^*.

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

Uwaga jak id i qty są przełączane dokoła dla drugiego produktu, ponieważ kolejność atrybutów nie ma znaczenia.

---

^* Jest konwencja używać przecinków, gdy zlecenie jest ważne, a średniki, gdy zamówienie nie jest ważne.

Answer 2

Oto jeden pomysł, aby przekazać parametr:

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

gdzie

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

jest reprezentacją JSON klasy 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; 
    } 

} 

, dzięki czemu można łatwo przekonwertować parametr zapytania productDetail w List<kv> przy użyciu

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

niż można łatwo iterować wszystkie elementy.

Inną propozycją jest, jeśli nie wiesz, ile produktów jest zapytanych, użyj do tego prośby POST.