W tym dokumencie opisujemy techniki, które mogą poprawić wydajność Twojej aplikacji. W niektórych przypadkach do zilustrowania prezentowanych pomysłów użyliśmy przykładów z innych interfejsów API lub ogólnych interfejsów API. Te same pojęcia dotyczą jednak interfejsu Google Photos Library API.
Kompresja za pomocą gzip
Kompresja gzip pozwala łatwo i wygodnie zmniejszyć przepustowość potrzebną do obsługi żądań. Chociaż dekompresja wyników wymaga dodatkowego czasu procesora, to kompresja kosztów sieciowych zazwyczaj jest bardzo opłacalna.
Aby odebrać odpowiedź zakodowaną w formacie gzip, ustaw nagłówek Accept-Encoding
i zmodyfikuj klienta użytkownika tak, aby zawierał ciąg znaków gzip
. Oto przykład prawidłowo sformatowanych nagłówków HTTP, które umożliwiają włączenie kompresji gzip:
Accept-Encoding: gzip User-Agent: my program (gzip)
Praca z częściowymi zasobami
Innym sposobem na poprawę wydajności wywołań interfejsu API jest przesyłanie żądań tylko do części danych, które Cię interesują. Dzięki temu aplikacja nie będzie przesyłać, analizować i przechowywać niepotrzebnych pól, a tym samym efektywniej wykorzystywać zasoby, w tym sieć, procesor i pamięć.
Odpowiedź częściowa
Po przetworzeniu żądań serwer domyślnie odsyła pełną reprezentację zasobu. Aby uzyskać lepszą wydajność, możesz wysłać do serwera prośbę o wysyłanie tylko tych pól, których potrzebujesz, i otrzymywanie odpowiedzi częściowej.
Aby wysłać takie żądanie, użyj parametru żądania fields
, określając w nim pola, które chcesz otrzymać. Tego parametru możesz używać w przypadku każdego żądania, które zwraca dane odpowiedzi.
Przykład
Przykład poniżej pokazuje użycie parametru fields
w generatywnym (fikcyjnym) interfejsie API „Demo”.
Proste żądanie: to żądanie HTTP GET
pomija parametr fields
i zwraca pełny zasób.
https://www.googleapis.com/demo/v1
Odpowiedź z pełnym zasobem: pełne dane zasobu zawierają poniższe pola i wiele innych, które zostały pominięte ze względu na długość.
{ "kind": "demo", ... "items": [ { "title": "First title", "comment": "First comment.", "characteristics": { "length": "short", "accuracy": "high", "followers": ["Jo", "Will"], }, "status": "active", ... }, { "title": "Second title", "comment": "Second comment.", "characteristics": { "length": "long", "accuracy": "medium" "followers": [ ], }, "status": "pending", ... }, ... ] }
Żądanie odpowiedzi częściowej: poniższe żądanie tego samego zasobu używa parametru fields
, aby znacznie zmniejszyć ilość zwracanych danych.
https://www.googleapis.com/demo/v1?fields=kind,items(title,characteristics/length)
Odpowiedź częściowa: w odpowiedzi na powyższe żądanie serwer wysyła odpowiedź zawierającą tylko informacje o rodzaju oraz skróconą tablicę elementów, która w każdym elemencie zawiera tylko informacje o tytułach HTML i długości.
200 OK
{ "kind": "demo", "items": [{ "title": "First title", "characteristics": { "length": "short" } }, { "title": "Second title", "characteristics": { "length": "long" } }, ... ] }
Pamiętaj, że odpowiedź jest obiektem JSON, który zawiera tylko wybrane pola i ich obiekty nadrzędne.
Szczegółowe informacje o formatowaniu parametru fields
znajdziesz poniżej. Opisaliśmy też szczegółowo zawartość odpowiedzi.
Podsumowanie składni parametru Fields
Format wartości parametru żądania fields
jest luźno oparty na składni XPath. Podsumowanie obsługiwanej składni znajdziesz poniżej. Dodatkowe przykłady znajdziesz w następnej sekcji.
- Aby wybrać wiele pól, użyj listy rozdzielanej przecinkami.
- Użyj
a/b
, aby wybrać poleb
zagnieżdżone w polua
. Użyja/b/c
, aby wybrać polec
zagnieżdżone w polub
.
Wyjątek: jeśli odpowiedź interfejsu API używa kodu danych i jest zagnieżdżona w obiekcie
data
, który wygląda jakdata: { ... }
, nie dodawaj „data
” do specyfikacjifields
. Dodanie obiektu danych do specyfikacji pól, np.data/a/b
, powoduje błąd. Użyj tylko specyfikacjifields
, takiej jaka/b
. - Użyj selektora podrzędnego, aby zażądać zbioru konkretnych podrzędnych pól tablic lub obiektów. W tym celu umieść wyrażenia w nawiasach „
( )
”.Przykład:
fields=items(id,author/email)
zwraca tylko identyfikator produktu i adres e-mail autora każdego elementu w tablicy items. Możesz też podać jedno pole podrzędne, gdziefields=items(id)
jest równoważne zfields=items/id
. - Jeśli to konieczne, w wybranych polach używaj symboli wieloznacznych.
Przykład:
fields=items/pagemap/*
wybiera wszystkie obiekty w elemencie pagemap.
Więcej przykładów użycia parametru pol
W poniższych przykładach opisano, jak wartość parametru fields
wpływa na odpowiedź.
Uwaga: tak jak każda wartość parametru zapytania, wartość parametru fields
musi być zakodowana na potrzeby adresu URL. Aby zwiększyć czytelność, w przykładach w tym dokumencie pominięto kodowanie.
- Wskaż pola, które chcesz zwrócić, lub wybierz pola.
- Wartość parametru żądania
fields
ma postać listy pól oddzielonej przecinkami. Każde pole jest określane względem elementu głównego odpowiedzi. Oznacza to, że jeśli wykonujesz operację na liście, odpowiedź jest kolekcją, która zwykle zawiera tablicę zasobów. Jeśli wykonujesz operację, która zwraca 1 zasób, pola są określane względem tego zasobu. Jeśli wybrane pole jest tablicą (lub jej częścią), serwer zwraca wybraną część wszystkich elementów tablicy.
Oto kilka przykładów na poziomie kolekcji:
Przykłady Efekt items
Zwraca wszystkie elementy tablicy, łącznie ze wszystkimi polami w każdym elemencie (nie zwraca żadnych innych pól). etag,items
Zwraca zarówno pole etag
, jak i wszystkie elementy tablicy.items/title
Zwraca tylko pole title
każdego elementu tablicy.
Gdy jest zwracane zagnieżdżone pole, odpowiedź zawiera obiekty nadrzędne. Pola nadrzędne nie zawierają żadnych innych pól podrzędnych, chyba że zostaną wyraźnie zaznaczone.context/facets/label
Zwraca tylko pole label
każdego elementu tablicyfacets
, która jest zagnieżdżona w obiekciecontext
.items/pagemap/*/title
Zwraca tylko pole title
(jeśli jest obecne) każdego elementu tablicy we wszystkich obiektach podrzędnych obiektupagemap
.
Oto kilka przykładów na poziomie zasobu:
Przykłady Efekt title
Zwraca pole title
żądanego zasobu.author/uri
Zwraca pole podrzędne uri
obiektuauthor
w żądanym zasobie.links/*/href
Zwraca pole href
wszystkich obiektów podrzędnych obiektulinks
. - Aby żądać tylko fragmentów pól, dokonaj wyborów podrzędnych.
- Jeśli żądanie dotyczy określonych pól, serwer zwraca domyślnie całe obiekty lub elementy tablicy. Możesz określić odpowiedź zawierającą tylko określone pola podrzędne. W tym celu użyj składni wyboru podrzędnego „
( )
”, jak pokazujemy w przykładzie poniżej.Przykład Efekt items(title,author/uri)
Zwraca tylko wartości title
iuri
autora z każdego elementu tablicy.
Obsługa odpowiedzi częściowych
Gdy serwer przetworzy prawidłowe żądanie z parametrem zapytania fields
, razem z żądanymi danymi wysyła kod stanu HTTP 200 OK
. Jeśli parametr zapytania fields
zawiera błąd lub jest nieprawidłowy z innego powodu, serwer zwraca kod stanu HTTP 400 Bad Request
i komunikat o błędzie z informacją o problemie z wyborem pól (np. "Invalid field selection a/b"
).
Oto przykład odpowiedzi częściowej, którą znajdziesz powyżej we wprowadzeniu. Aby określić, które pola zwrócić, żądanie używa parametru fields
.
https://www.googleapis.com/demo/v1?fields=kind,items(title,characteristics/length)
Odpowiedź częściowa wygląda tak:
200 OK
{ "kind": "demo", "items": [{ "title": "First title", "characteristics": { "length": "short" } }, { "title": "Second title", "characteristics": { "length": "long" } }, ... ] }
Uwaga: w przypadku interfejsów API, które obsługują parametry zapytania do podziału danych na strony (na przykład maxResults
i nextPageToken
), te parametry pozwalają zmniejszyć liczbę wyników każdego zapytania do rozmiaru, który ułatwia obsługę. W przeciwnym razie wzrost wydajności związany z odpowiedziami częściowymi może nie zostać osiągnięty.