JSON Şema Oluşturucu ne işe yarar?

Bir veri örneğinden sizin için JSON Şeması oluşturur. Bir API yanıtı, yapılandırma dosyası veya veritabanı dışa aktarımından bir kayıt gibi örnek bir veri yapıştırın; verinin yapısını açıklayan bir şema elde edin: her değerin türü, her nesnenin özellikleri, her dizinin öğelerinin görünümü ve hangi özelliklerin zorunlu olduğu. Bu, API belgeleri, OpenAPI spesifikasyonları, form doğrulama veya veri sözleşmeleri için hızlı bir başlangıç sağlar; daha sonra şemayı elle ayrıntılandırabilirsiniz.

Nasıl kullanılır?

  1. Giriş kutusuna örnek JSON yapıştırın veya yazın.
  2. $schema satırı için JSON Schema taslağını seçin: Taslak 2020-12 veya Taslak 7.
  3. Özelliklerin zorunlu olarak işaretlenip işaretlenmeyeceğini seçin.
  4. Şemayı kopyalayın veya schema.json olarak indirin.

Örnek geçerli JSON değilse araç sorunun bulunduğu satır ve sütunu bildirir ve işaretler.

Şema nasıl oluşturulur?

  • Her değere JSON türü atanır: string, boolean, null, object, array; tam sayılar için integer, ondalıklı sayılar için number. Tam ve ondalıklı sayılardan oluşan bir diziye number atanır; bu tür her ikisini de kapsar.
  • Nesnelerde her anahtar için, örnekteki derinlik düzeyine kadar aynı şekilde açıklanan bir properties girdisi oluşturulur.
  • Dizilerde tüm öğelere uyan tek bir items şeması oluşturulur. Öğeler nesne olduğunda özellikleri birleştirilir; böylece kayıt listesinden tek bir kayıt şeması elde edilir.
  • Farklı türlerdeki değerlere ["string", "null"] gibi bir listeyle tüm türler atanır veya nesnelerle diğer değerler bir aradaysa anyOf kullanılır.
  • Boş bir diziye, açıklanacak hiçbir şey olmadığından items içermeyen "type": "array" atanır.

Zorunlu özellikler

"Özellikleri zorunlu olarak işaretle" seçeneği açıkken her nesnenin anahtarları required altında listelenir. Nesne dizilerinde bir özellik yalnızca her öğede varsa zorunlu sayılır: bazı üyelerde favori bulunan bir listede bu özellik isteğe bağlıdır. required listeleri içermeyen bir şema oluşturmak için seçeneği kapatın.

Bir örnekten anlaşılamayanlar

Tek bir örnekten oluşturulan şema yalnızca örnekte gösterilenleri bilir. Hangi metin değerlerinin e-posta adresi veya tarih olduğunu, sayıların hangi aralıklarda olabileceğini ya da bir kez görülen bir özelliğin bulunmayabileceğini anlayamaz. Gereken yerlere format, minimum, maxLength, enum veya pattern değerlerini elle ekleyin ve sonucu JSON Schema Doğrulayıcı ile veriler üzerinde doğrulayın.

Nasıl çalışır?

Araç, GenSON şema oluşturucusunun JavaScript uyarlaması olan genson-js'i kullanır. Yazdığı anahtar sözcükler Draft 7 ve Draft 2020-12'de aynı anlama gelir; bu nedenle taslak seçimi yalnızca $schema satırını değiştirir. Her şey tarayıcınızda çalışır: örnek hiçbir zaman yüklenmez.

Özellikler

  • Herhangi bir örnek JSON'dan JSON Schema oluşturma
  • Türler, iç içe nesneler ve diziler sizin için belirlenir
  • Dizi öğeleri tek bir şemada birleştirilir ve isteğe bağlı özellikler belirlenir
  • Taslak 2020-12 veya Taslak 7
  • Zorunlu özellikleri açma veya kapatma
  • schema.json olarak kopyalama veya indirme
  • Tarayıcınızda çalışır