Muotoile JSON ja kopioi arvon JSON Pointer -polku
Muotoile yksirivinen API-vastaus selaimessa ja kopioi arvon JSON Pointer -polku puunäkymästä. Esimerkeissä näytetään myös tiivistys ja syntaksin tarkistus.
Kun API palauttaa JSONin yhdellä rivillä, rivinvaihdot helpottavat arvojen lukemista. Jos kerrot toisen tuotteen olevan loppu varastosta, liitä mukaan polku, jotta muutkin löytävät saman arvon. Kokeile molempia toimintoja kuvitteellisella tuoteluettelolla. Avaa sitä varten JSONin muotoilu-, tiivistys- ja tarkistustyökalu. Liittämäsi tiedot käsitellään selaimessa.
Yksirivisen vastauksen selkeyttäminen
Liitä seuraava esimerkki kenttään ”Syöte-JSON”.
{"items":[{"sku":"A-001","stock":12},{"sku":"B-002","stock":0}]}
- Aseta kentän ”Sisennys” arvoksi
2ja napsauta painiketta ”Pretty →”. - Etsi kentästä ”Tuloste” taulukon
itemstoinen alkio. Tuotteen, jonkaskuonB-002, kentänstockarvo on0. - Tallenna muotoiltu tulos tiedostoon napsauttamalla ensin ”Copy”. Liitä sitten tulos tekstieditoriin ja tallenna se. Jos tarvitset tiiviin yhden rivin, napsauta ennen kopiointia ”Minify →”.
Toisen tuotteen varastosaldon polun etsiminen puusta
- Pidä syöte ennallaan ja napsauta ”Puunäkymä”.
- Laajenna
itemsja[1]ja valitse"stock": 0. Taulukon indeksi alkaa nollasta, joten[1]on toinen alkio. - Tarkista, että valittu JSON Pointer on
/items/1/stock, ja napsauta ”Kopioi polku”. Kirjaa polun lisäksi, minkä vastauksen tarkistit.
JSON Pointerissa avaimen vinoviiva merkitään ~1 ja aaltoviiva ~0. Esimerkiksi yksittäinen avain stock/on-hand kirjoitetaan stock~1on-hand. Katso RFC 6901:n syntaksi.
Syntaksin tarkistaminen, kun muotoilu epäonnistuu
Jos kirjoitat toisen alkion muodossa {"sku":"B-002","stock":0,}, pilkku ennen sulkevaa aaltosulkua aiheuttaa syntaksivirheen. Tarkista syöte painikkeella ”Validate”. Jos selain antaa virheen sijainnin, työkalu näyttää rivin ja sarakkeen. Poista pilkku ja napsauta uudelleen ”Validate” ennen muotoilua.
”Validate” tarkistaa JSONin syntaksin. API:n määrityksestä tai skeemasta selviää, onko stock pakollinen tai voiko sen arvo olla negatiivinen.