Blogi

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.

Englanninkielisessä käyttöliittymässä yksirivinen JSON näkyy sisennetyn tulosteen vieressä.

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}]}
  1. Aseta kentän ”Sisennys” arvoksi 2 ja napsauta painiketta ”Pretty →”.
  2. Etsi kentästä ”Tuloste” taulukon items toinen alkio. Tuotteen, jonka sku on B-002, kentän stock arvo on 0.
  3. Tallenna muotoiltu tulos tiedostoon napsauttamalla ensin ”Copy”. Liitä sitten tulos tekstieditoriin ja tallenna se. Jos tarvitset tiiviin yhden rivin, napsauta ennen kopiointia ”Minify →”.
Englanninkielisen käyttöliittymän syötteessä näkyy tuoteluettelo ja tulosteessa kahdella välilyönnillä sisennetty JSON.
Erillisissä kentissä voit verrata alkuperäistä riviä muotoiltuun rakenteeseen.

Toisen tuotteen varastosaldon polun etsiminen puusta

  1. Pidä syöte ennallaan ja napsauta ”Puunäkymä”.
  2. Laajenna items ja [1] ja valitse "stock": 0. Taulukon indeksi alkaa nollasta, joten [1] on toinen alkio.
  3. Tarkista, että valittu JSON Pointer on /items/1/stock, ja napsauta ”Kopioi polku”. Kirjaa polun lisäksi, minkä vastauksen tarkistit.
Englanninkielisessä puunäkymässä items-taulukon toinen alkio on auki ja valitun stock-arvon polku /items/1/stock näkyy kentässä.
Polkukenttä näyttää valitun arvon sijainnin. Itse arvo on 0.

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.