Sol·licita la teva primera API a l’app Dreceres del Mac
Per sol·licitar la teva primera API, has de crear l’URL que apunta al “punt final” de l’API amb el qual vols parlar, i després, passa aquest URL a l’acció “Obtenir el contingut de l’URL”. Quan s’executa la drecera, aquesta acció fa la sol·licitud API.
Crear la sol·licitud de l’API
El punt final de Typicode requereix que la sol·licitud tingui aquest format:
https://jsonplaceholder.typicode.com/[RECURS]
El text entre claudàtors és el recurs al qual vols accedir. Typicode ofereix molts exemples diferents per provar sol·licituds. Aquest exemple utilitzarà https://jsonplaceholder.typicode.com/users per sol·licitar una llista d’usuaris.
A l’app Dreceres
del Mac, afegeix la sol·licitud a l’URL.La sol·licitud de
usersretornarà una llista d’usuaris.Pots afinar la cerca especificant un usuari concret pel seu ID:
https://jsonplaceholder.typicode.com/users/6. Això retornarà l’usuari amb ID 6.La majoria d’API permeten fer sol·licituds amb el format següent:
https://jsonplaceholder.typicode.com/users?username=Bret. L’interrogant “?” inicia la sol·licitud, que cerca ítems fent servir les parelles clau/valor. En aquest exemple, la sol·licitud?username=Bretbusca l’usuari que té el nom d’usuari Bret.Consulta la documentació de l’API per obtenir informació sobre les sol·licituds i cerques compatibles.
Fer la sol·licitud API amb l’acció “Obtenir el contingut de l’URL”
A l’app Dreceres
del Mac, fes clic a “Mostrar més” a l’acció “Obtenir el contingut de l’URL”.Aquestes són les opcions de tipus de sol·licituds API que pots fer:
GETpermet obtenir dades.POSTpermet crear noves dades.PUTpermet actualitzar les dades substituint‑les.PATCHpermet actualitzar les dades modificant‑les.DELETEpermet eliminar un objecte especificat a la sol·licitud URL.
Per aquest exemple, utilitza una sol·licitud
GETper recuperar dades de l’API Typicode.Ara que l’acció URL té la teva sol·licitud i l’acció URL “Obtenir el contingut de l’URL” està definit en
GET, ja pots fer la sol·licitud API.Nota: Quan l’acció “Obtenir el contingut de l’URL” es canvia a
POST,PUToPATCH, s’afegeix un nou paràmetre anomenat “Sol·licitar el cos”. “Sol·licitar el cos” permet enviar un JSON, un Formulari o un Arxiu a l’API com a part de la teva sol·licitud. Això et permet introduir noves dades manualment o mitjançant variables i pots enviar les dades a l’API per crear, substituir o modificar una entrada.Per provar la drecera, fes clic a
.
A simple vista, sembla que l’API retorni un text fet un batibull. Aquestes dades estan codificades en JSON, la sigla en anglès de Notació d’Objecte JavaScript.
Per aprendre a treballar amb JSON i continuar amb l’exemple de l’API Typicode, consulta Introducció a la utilització d’arxius JSON a l’app Dreceres del Mac.