Wysyłanie pierwszego żądania API w aplikacji Skróty na iPhonie lub iPadzie
Aby wysłać żądanie API, musisz utworzyć URL wskazujący „węzeł końcowy” API, a następnie przekazać ten URL do czynności Pobierz zawartość URL. Po uruchomieniu skrótu czynność ta wysyła żądanie API.
Tworzenie żądania API
Węzeł końcowy Typicode wymaga użycia adresu URL z żądaniem sformatowanego w następujący sposób:
https://jsonplaceholder.typicode.com/[ZASÓB]
Tekst w nawiasie kwadratowym to zasób, do którego chcesz uzyskać dostęp. Typicode oferuje wiele różnych przykładów do testowania zapytań. W naszym przykładzie użyjemy https://jsonplaceholder.typicode.com/users
, aby uzyskać listę użytkowników.
W aplikacji Skróty na urządzeniu iOS lub iPadOS dodaj żądanie do adresu URL.
Żądanie
users
zwróci listę użytkowników.Możesz zawęzić wyszukiwanie, podając identyfikator określonego użytkownika:
https://jsonplaceholder.typicode.com/users/6
. To żądanie zwróci użytkownika o identyfikatorze 6.W przypadku większości API zapytania mają następujący format:
https://jsonplaceholder.typicode.com/users?username=Bret
. Znak zapytania „?” rozpoczyna zapytanie, którego celem jest wyszukanie pozycji jako par klucz/wartość. W tym przypadku zapytanie?username=Bret
wyszukuje użytkownika, którego nazwa to Bret.Obsługiwane wyszukiwania i zapytania znajdziesz w dokumentacji używanego API.
Wysyłanie żądania API przy użyciu czynności Pobierz zawartość URL
W aplikacji Skróty na urządzeniu iOS lub iPadOS stuknij w Pokaż więcej w czynności Pobierz zawartość URL.
Pojawią się następujące opcje dotyczące możliwych typów żądania API:
GET
pozwala na pobieranie danych.POST
pozwala na tworzenie nowych danych.PUT
pozwala na uaktualnianie danych przez ich zastępowanie.PATCH
pozwala na uaktualnianie danych przez ich modyfikowanie.DELETE
pozwala na usuwanie obiektu podanego w adresie URL żądania.
W tym przykładzie użyjemy żądania
GET
w celu pobrania danych przy użyciu API serwisu Typicode.Gdy czynność URL zawiera żądanie, a czynność Pobierz zawartość URL jest skonfigurowana do pobrania danych przy użyciu metody
GET
, wszystko jest gotowe do wysłania żądania API.Uwaga: Gdy metoda czynności Pobierz zawartość URL zostanie przełączona na
POST
,PUT
lubPATCH
, pojawi się nowy parametr o nazwie Żądanie treści. Pozwala on na wysłanie do API (jako części żądania) danych w formacie JSON, formularza lub pliku. Pozwala to na wprowadzanie nowych danych ręcznie lub przy użyciu zmiennych, umożliwiając wysyłanie danych do API w celu tworzenia, zastępowania lub zmieniania danego wpisu.Aby przetestować skrót, stuknij w .
Na pierwszy rzut oka dane zwracane przez API wyglądają jak chaotyczny tekst. Dane te są zakodowane w formacie JSON, czyli JavaScript Object Notation.
Aby dowiedzieć się więcej o pracy z danymi w formacie JSON oraz kontynuować przykład API Typicode, zobacz: Wprowadzenie do używania formatu JSON w aplikacji Skróty na iPhonie lub iPadzie.