JSON Schema Nedir? Veri Doğrulama ve Şema Oluşturma Rehberi

Modern web uygulamalarında ve mikroservis mimarilerinde veri alışverişinin büyük çoğunluğu JSON formatında gerçekleşir. Ancak, istemci ve sunucu arasında gönderilen JSON verilerinin doğru veri tiplerine, zorunlu alanlara ve beklenen yapıya sahip olması sistem güvenliği ve kararlılığı için kritik önem taşır. İşte bu noktada JSON Schema devreye girer.

JSON Schema Nedir?

JSON Schema, JSON nesnelerinin yapısını, içeriğini ve doğrulama kurallarını tanımlamak için kullanılan deklaratif ve standartlaştırılmış bir sözdizimidir. Tıpkı ilişkisel veritabanlarındaki tablo şemaları veya XML dünyasındaki XSD (XML Schema Definition) gibi, JSON Schema da bir JSON verisinin kabul edilebilir standartlara uyup uymadığını açıkça belirtir.

JSON Schema sayesinde bir JSON verisinde:

• Hangi alanların zorunlu (required) olduğu,
• Değişkenlerin veri tipleri (string, number, boolean, array, object),
• Sayısal değerlerin alt ve üst sınırları (minimum, maximum),
• Metin alanlarının uzunluğu veya Regex kalıpları (minLength, pattern),
• Dizilerin eleman sayıları ve içerik tipleri

açıkça tanımlanabilir.

JSON Schema Neden Kullanılmalıdır?

JSON Schema kullanmanın yazılım geliştirme süreçlerine sağladığı temel avantajlar şunlardır:

1. Otomatik Veri Doğrulama (Validation): Sunucunuza veya API uç noktanıza gelen verileri manuel if-else bloklarıyla kontrol etmek yerine, JSON Schema kütüphaneleri ile milisaniyeler içinde doğrulayabilirsiniz.
2. Açık ve Canlı Dokümantasyon: API sözleşmenizi (API contract) insan tarafından okunabilir ve makineler tarafından işlenebilir standart bir formatta sunarsınız.
3. İstemci ve Sunucu Uyumu: İstemci (frontend) ve sunucu (backend) ekiplerinin aynı veri modeli üzerinde tam bir mutabakatla çalışmasını sağlar.
4. Hatalı Veri Girişlerini Engelleme: Yanlış veya eksik yapılandırılmış veritabanı kayıtlarının önüne geçer.

Örnek Bir JSON Schema Yapısı

Aşağıdaki örnekte bir kullanıcı profilini tanımlayan basit bir JSON Schema görebilirsiniz:

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "id": {
      "type": "integer"
    },
    "name": {
      "type": "string",
      "minLength": 2
    },
    "email": {
      "type": "string",
      "format": "email"
    },
    "roles": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  },
  "required": ["id", "name", "email"]
}

Bu şema, id, name ve email alanlarının bulunmasının zorunlu olduğunu, name alanının en az 2 karakterden oluşması gerektiğini ve roles alanının metin dizisi olacağını belirtmektedir.

JSON Schema Nasıl Kolayca Oluşturulur?

Karmaşık JSON nesneleri için elle şema yazmak zaman alıcı ve hataya açık olabilir. Var olan bir JSON verisinden saniyeler içinde otomatik şema üretmek için JSON Schema Generator aracımızı kullanabilirsiniz.

Ayrıca JSON verilerinizin okunabilirliğini artırmak ve sözdizimi hatalarını düzeltmek için JSON Formatter aracımızdan da yararlanabilirsiniz. Veri yapınızı standartlaştırarak API geliştirmelerinizi çok daha güvenli ve hızlı hale getirebilirsiniz.