Ensimmäisen APIn pyytäminen iPhonen tai iPadin Pikakomennoissa
Luo ensimmäisen API-pyynnön tekemistä varten URL, joka on kohdistettu haluamallesi API-päätepisteelle, ja vie kyseinen URL Hae URLin sisältö -toimintoon. Kun pikakomento suoritetaan, tämä toiminto tekee API-pyynnön.
API-pyynnön tekeminen
Typicoden päätepiste edellyttää seuraavan muotoista URL-pyyntöä:
https://jsonplaceholder.typicode.com/[RESURSSI]
Sulkeissa olevan tekstin paikalle tulee resurssi, jota haluat käyttää. Typicode tarjoaa monia erilaisia esimerkkejä pyyntöjen testaamista varten. Tässä esimerkissä käytetään URLia https://jsonplaceholder.typicode.com/users käyttäjäluettelon pyytämiseksi.
Lisää iOS- tai iPadOS-laitteen Pikakomennot-apissa
pyyntö URLiin.users-pyyntö palauttaa luettelon käyttäjistä.Voit rajata hakua määrittämällä tietyn käyttäjän id:llä:
https://jsonplaceholder.typicode.com/users/6. Tämä palauttaa käyttäjän, jonka id on 6.Useimmat APIt sallivat seuraavaa muotoa käyttävät kyselyt:
https://jsonplaceholder.typicode.com/users?username=Bret. ”?” käynnistää kyselyn, joka etsii kohteita käyttämällä avain/arvo-pareja. Tässä esimerkissä kysely?username=Bretetsii käyttäjää, jonka käyttäjätunnus on Bret.Tarkista tuetut haut ja kyselyt APIn dokumentaatiosta.
API-pyynnön suorittaminen Hae URLin sisältö -toiminnolla
Napauta iOS- tai iPadOS-laitteen Pikakomennot-apissa
Hae URLin sisältö ‑toiminnossa Näytä lisää.Seuraavat API-pyyntöjen tyypit ovat nyt valittavissa:
GET-pyynnöllä voit hakea dataa.POST-pyynnöllä voit luoda uutta tietoa.PUT-pyynnöllä voit päivittää dataa korvaamalla sitä.PATCH-pyynnöllä voit päivittää dataa muokkaamalla sitä.DELETE-pyynnöllä voit poistaa objektin, joka on määritetty URL-pyynnössä.
Käytä tässä esimerkissä
GET-pyyntöä tietojen saamiseen Typicode-APIsta.Nyt kun URL-toiminto sisältää pyyntösi ja Hae URLin sisältö -toimintoon on asetettu
GET-pyyntö datan saamista varten, olet valmis tekemään API-pyynnön.Huomaa: Jos Hae URLin sisältö -toimintoon vaihdetaan
POST,PUTtaiPATCH, lisätään uusi parametri nimeltä Pyynnön runko. Pyynnön runko -parametrin avulla voit sisällyttää pyynnön osaksi JSON-muotoista dataa, Lomakkeen tai Tiedoston. Näin voit syöttää uutta dataa käsin tai muuttujien avulla ja voit lähettää datan APIin tietueen luomista, korvaamista tai muokkaamista varten.Voit kokeilla pikakomentoa napauttamalla
.
Ensinäkemältä API näyttää palauttavan outoa tekstiä. Tiedot on koodattu JSON-muodossa (JavaScript Object Notation).
Jos haluat oppia JSONin käyttöä ja jatkaa Typicode-API-esimerkin parissa, katso Johdanto JSONin käyttämiseen iPhonen ja iPadin Pikakomennoissa.