JSON Schema -generaattori
Luo JSON Schema JSON-datasta automaattisesti
JSON-syöte
Luotu skeema
Mikä on JSON Schema -generaattori?
Oletko koskaan joutunut kirjoittamaan JSON Scheman käsin tyhjästä? Se on työlästä. Tämä työkalu tekee sen puolestasi — liitä esimerkkijson-objekti ja se luo välittömästi skeeman, joka kuvaa kyseisen rakenteen: tyypit, ominaisuudet, pakolliset kentät ja sisäkkäiset objektit. Generoitu skeema noudattaa RFC 8259:n JSON-käytäntöjä ja on yhteensopiva esimerkiksi Ajvn kanssa. Käytä sitä lähtökohtana API-dokumentaatiolle, dataputouksien validoinnille tai OpenAPI-määrittelyjä varten.
Tämä työkalu toimii selaimessasi. Liitä JSON ja se luo JSON Schema -luonnoksen. Mitään ei lähetetä palvelimelle.
Miten työkalua käytetään
Liitä esimerkkidataa
Liitä JSON, joka edustaa rakennetta, jonka haluat kuvata. Käytä Esimerkki- tai Lataa-painiketta tarvittaessa. Generaattori päättelee tyypit arvoista (merkkijono, numero, boolean, taulukko, objekti).
Tarkista skeema
Oikea paneeli näyttää generoidun skeeman. Se voi sisältää type-, properties-, required-kenttiä ja sisäkkäisiä skeemoja objekteille. Voit muokata sitä manuaalisesti tarvittaessa.
Kopioi tai lataa
Käytä Kopioi tai Lataa tiedostona saadaksesi skeeman. JSON:n validointiin skeemaa vasten käytä JSON-tarkistinta tai kirjastoa kuten Ajv.
JSON Schema -esimerkkejä
Luo skeema esimerkkidatasta. Telecom-aiheinen esimerkki:
JSON-syöte
Luotu skeema
Milloin käyttää generoitua skeemaa
Generoidut skeemat ovat lähtökohta. Ne kuvaatvat esimerkkidatasi rakenteen, mutta saattavat olla liian tiukkoja tai löyssiä. Sinun täytyy ehkä lisätä required-taulukoita, säätää tyyppejä tai lisätä enum sallituille arvoille. JSON Schema -dokumentaatio selittää koko sanaston. API-dokumentaatioon työkalut kuten OpenAPI voivat viitata JSON Schemaan.
Usein kysyttyä
Voinko validoida JSON:ia tällä skeemalla?
Tämä työkalu vain generoi skeemoja. Validointiin käytä JSON-tarkistinta tai kirjastoa kuten Ajv koodissasi.
Entä jos JSON:llani on erilaisia muotoja?
Generaattori päättelee antamastasi esimerkistä. Jos JSON voi olla useita muotoja (esim. valinnaiset kentät), skeema saattaa tarvita manuaalisia muokkauksia. Käytä oneOf tai anyOf varianteille.
Lähetetäänkö datani minnekään?
Ei. Generointi tapahtuu selaimessasi.
Mitä JSON Schema -luonnosta käytetään?
Työkalu voi käyttää draft-07:aa tai draft-2020-12:ta. Tarkista generoidusta skeemasta $schema nähdäksesi version. JSON Schema -määrittely sisältää yksityiskohdat.
Voinko käyttää tätä API-vastauksiin?
Kyllä. Liitä tyypillinen API-vastaus. Luotu skeema kuvaa kyseisen rakenteen. Voit sitten käyttää sitä OpenAPI/Swaggerissa tai dokumentaatiossa.
Liittyvät työkalut
Lisää: json-schema.org ja JSON Schema -opas. Koodivalidointiin: Ajv. JSON:lle: json.org, MDN ja RFC 8259. API-dokumentaatioon: OpenAPI.