Vyžiadanie prvého API v apke Skratky na iPhone alebo iPade
Ak chcete odoslať svoju prvú požiadavku API, vytvorte URL adresu odkazujúcu na „koncový bod“ rozhrania API, s ktorým chcete komunikovať, a potom túto URL adresu odovzdajte do akcie Získať obsah URL. Po spustení skratky vytvorí táto akcia požiadavku API.
Zostavenie požiadavky API
Koncový bod služby Typicode vyžaduje požiadavku URL v nasledujúcom formáte:
https://jsonplaceholder.typicode.com/[RESOURCE]
Text v zátvorkách je zdroj, ku ktorému chcete získať prístup. Typicode poskytuje mnoho rôznych príkladov na testovanie požiadaviek. Tento príklad bude používať https://jsonplaceholder.typicode.com/users na vyžiadanie zoznamu užívateľov.
V apke Skratky
na iOS alebo iPadOS zariadení pridajte požiadavku do URL.Požiadavka
usersvráti zoznam užívateľov.Vyhľadávanie môžete zúžiť zadaním konkrétneho užívateľa podľa id:
https://jsonplaceholder.typicode.com/users/6. Toto vráti užívateľa, ktorého id je 6.Väčšina rozhraní API umožňuje dotazy používajúce nasledujúci formát:
https://jsonplaceholder.typicode.com/users?username=Bret. Znak „?“ spustí požiadavku, ktorá hľadá položky použitím párov kľúč/hodnota. V tomto príklade vyhľadáva dotaz?username=Brettakého užívateľa, ktorého užívateľské meno je Bret.Podporované vyhľadávania a dotazy nájdete v API dokumentácii.
Odoslanie požiadavky API s akciou Získať obsah URL
V apke Skratky
na iOS alebo iPadOS zariadení klepnite v akcii Získať obsah URL na Zobraziť viac.Pre typy požiadaviek API, ktoré možno zadať, sa sprístupnia nasledujúce možnosti:
Požiadavka
GETumožňuje načítať dáta.Požiadavka
POSTumožňuje vytvoriť nové dáta.Požiadavka
PUTumožňuje aktualizovať dáta tým, že ich nahradí.Požiadavka
PATCHumožňuje aktualizovať dáta tým, že ich upraví.Požiadavka
DELETEumožňuje odstrániť objekt zadaný v požiadavke URL.
V tomto príklade načítate dáta z rozhrania API služby Typicode pomocou požiadavky
GET.Teraz, keď akcia URL obsahuje vašu požiadavku a akcia Získať obsah URL je nastavená na načítanie dát (
GET), ste pripravení na odoslanie požiadavky API.Poznámka: Po prepnutí akcie Získať obsah URL na požiadavku
POST,PUTaleboPATCHsa pridá nový parameter s názvom Telo požiadavky. Parameter Telo požiadavky umožňuje odoslať do rozhrania API ako súčasť požiadavky dáta JSON, formulár alebo súbor. Môžete tak zadať nové dáta manuálne alebo pomocou premenných, vďaka čomu môžete do rozhrania API odoslať dáta na vytvorenie, nahradenie alebo úpravu položky.Ak chcete skratku otestovať, klepnite na
.
Pri prvom pohľade rozhranie API vracia množstvo neprehľadného textu. Tieto dáta sú zakódované vo formáte JSON, čo je skratka pre JavaScript Object Notation.
Informácie o práci s formátom JSON a pokračovanie príkladu s rozhraním API služby Typicode nájdete v téme Úvod do používania formátu JSON v apke Skratky na iPhone alebo iPade.