Restful API - obsługa dużych ilości danych

Question

Napisałem własne Restful API i zastanawiam się, jak najlepiej radzić sobie z dużą ilością rekordów zwracanych z API.

Na przykład, jeśli użyję metody GET do myapi.co.uk/messages/, spowoduje to przywrócenie kodu XML dla wszystkich rekordów komunikatów, które w niektórych przypadkach mogą mieć wartość 1000. To sprawia, że ​​korzystanie z API jest bardzo powolne.

Czy ktoś może zaproponować najlepszy sposób radzenia sobie z tym? Czy w standardzie zwracanie wyników w partiach i określanie wielkości partii w żądaniu?

Answer 1

Możesz zmienić swój interfejs API, dodając dodatkowe parametry w celu ograniczenia zakresu danych zwracanych przez aplikację.

Na przykład można dodać parametry limit i offset, aby pobrać tylko niewielką część. W ten sposób można dokonać podziału na strony zgodnie z REST. Takie żądanie spowodowałoby pobranie 10 zasobów z kolekcji wiadomości od 21 do 30. W ten sposób można poprosić o konkretnej części ogromnego zbioru danych:

myapi.co.uk/messages?limit=10&offset=20 

Innym sposobem, aby zmniejszyć ładunek byłoby tylko poprosić o pewnych częściach reprezentacji zasobów. Oto jak facebook robi:

/joe.smith/friends?fields=id,name,picture 

Pamiętaj, że podczas korzystania z jednej z tych metod, trzeba zapewnić drogę dla klienta, aby odkryć siebie zasobów. Nie można zakładać, że po prostu spojrzą na parametry i zaczną je zmieniać w poszukiwaniu danych. Byłoby to naruszeniem paradygmatu REST. Podaj im niezbędne hiperlinki, aby tego uniknąć.

Gorąco polecam oglądanie this presentation on RESTful API design przez apigee (screencast nazywa się "Naucz psa do odpoczynku"). Tutaj omawiane są dobre praktyki i zgrabne pomysły na podejście do codziennych problemów.

EDIT: Film został zaktualizowany kilka razy od kiedy pisał tę odpowiedź, można zapoznać się z 3rd edition from January 2013