REST API i GET, Konwencja Opcje

[markonix]

Jaka jest dobra konwencja przy metodzie GET:

1) Zwrócenie wszystkich wierszy
2) Zwrócenie wszystkich rekordów z danej tabeli przynależnych do odpytującego usera?

Jeżeli 1) to jak odpytać o to co w punkcie 2)? Osobna metoda, jakiś filtr?

Chodzi o dobre praktyki, a nie o to jak to napisać.

[SHiP]

Najlepsza konwencja moim zdaniem, to taka, którą prezentują Facebook/Vimeo. Wystarczy wybrać najlepsze rzeczy.

Nazwa powinna od razu wskazywać czy dostaniemy jeden, czy więcej rekordów

/users - pobiera kilku użytkowników
/user/2 - pobiera jednego użytkownika o ID = 2

/articles - pobiera kilka artykułów
/article/124 - pobiera jeden artykuł

I teraz dochodzą parametry. Jeżeli chcemy pobrać użytkownika o ID 6

/user/6

Jeżeli artykuł o ID 5

/article/5

Jeżeli artykuły użytkownika o ID 6

/user/6/articles/

Jeżeli wszystkie artykuły

/articles

Wszystko powinno być wykonywane w kontekście użytkownika/właściciela aby potem nie mieć problemów z tokenami dostępu:

Artykuły użytkownika o ID 6:

/articles/user/6 - źle

/user/6/articles - dobrze

+ zawsze można dodać alias do aktualnego użytkownika, którego tokenem się posługujemy

/me/articles
/me/friends

i metoda HTTP:

GET - pobieranie danych
POST - wrzucanie danych
PUT/PATCH - aktualizacja danych
DELETE - usuniecie danych

Ten post edytował SHiP 6.06.2016, 17:29:27