[wafel93]

#programowanie
Mirki jakie jest prawidłowe podejście w projektowaniu api webowego, w takim przypadku:
Mamy jakiś Product, który ma powtarzalne nazwy oraz różne gramatury -> a więc jeden Product określa nazwa, gramatura + pare czynników z tym połączeniem związanych (powiedzmy, ze np. cena, dostepność). Jak określić dobrze API?

wszystkie produkty -> api/product

wszystkie unikalne nazwy produktu -> api/product-names czy api/product/name

dostępne gramatury dla danej nazwy produktu -> api/product-name/x/weight czy api/product/weight?name=x

[IJarzi]

@wafel93: Ty leniu śmierdzący :D a popatrzeć na url jak np. wyszukujesz coś w google to się nie chce? Zakładam że chodzi o restowe API https://apiguide.readthedocs.io/en/latest/build_and_publish/use_RESTful_urls.html

[wafel93]

@IJarzi: wbrew pozorom to nie jest taki easy case - name jest częścią produkt, relacja typu has jak wspomniane w art articles, ale tutaj zwrócić chce WSZYSTKIE unikalne parametry "name". Czyli bardziej czytelne jest api/products?fields=name ? Czy może api/product-names? A może api/products/names?

[IJarzi]

@wafel93: v1/api/products/{id}/names na mój gust

[wafel93]

@IJarzi: heh no właśnie WSZYSTKIE nazwy - nie produktu o danym ID :)

[wafel93]

@IJarzi: mam na myśli, ze Twoja propozycja zwróci name dla konkretnego produktu - a więc tylko jeden. Ja potrzebuję wszystkich.

[IJarzi]

@wafel93: no dobra to odwołuję tego lenia śmierdzącego, ja bym zaproponował coś takiego jak Google proponuje https://cloud.google.com/apis/design/design_patterns#list_sub-collections czyli v1/api/products/-/names

[wafel93]

@IJarzi: wow, nie znałem tego. A co z 3 przypadkiem? Weights dla danej nazwy -
API/products/-/weights?name=xxx
?

[IJarzi]

@wafel93: v1/api/products/-/names/{id}/weights, ale nie wiem czy dobrze zrozumiałem, doprecyzuj co to jest weights?

[wafel93]

@IJarzi: para weight (100g, 1kg, etc) oraz name (ryż, kasza) składa się na produkt z ceną.

[IJarzi]

@wafel93: ja bym zrobił dwa end pointy z names i oddzielnie weights, a czemu np. pobranie wszystkich produktów nie wchodzi w grę?

[wafel93]

@IJarzi: z osobnymi endpointami to jest problem taki, że nie możesz utworzyć samej nazwy produktu - ta osobna tabela nazw jest tylko dla optymalizacji, ciężko rozpatrywać ja jako osobny resource. Pobranie wszystkich produktów nie wchodzi w grę że względu na wielkość danych - dostałbyś np pięć rodzajów ryżu białego z mnóstwem niepotrzebnych informacji. A tak po prawdzie, front tutaj potrzebuje tylko nazwy "ryż biały".

[IJarzi]

@wafel93: w takim razie jak użyjesz v1/api/products?fields=id,name,weight będzie ok

[wafel93]

@IJarzi: dodać jeszcze query I chyba mamy to:
v1/api/products?fields=weight&name=xxx

[IJarzi]

@wafel93: jeśli przeszukujesz produkty po nazwie xxx i wyciągasz tylko weight to ok

[wafel93]

@IJarzi: o to chodzi koleżko (⌐ ͡■ ͜ʖ ͡■) dzięki wielkie za pomoc