Ortak Sorgu Modeli, mesajın içerisinde (genellikle gövde bölümündeki) ne tipte verinin olduğunu tarif eden metadata bilgisidir.

Ek olarak, burada oluşturulan model, Spec Tasarım Editörü içerisinde içe aktarılarak kullanılabilir.

Ortak Veri Modeli Oluşturma

Liste arayüzünün sağ üst kısmındaki Yeni (Create) butonuna tıklanarak yeni bir Sorgu Modeli oluşturulabilir.


Ortak Veri Modeli oluşturma ayarlarını içeren görsele aşağıda yer verilmiştir:


Ortak sorgu modeli oluşturma konfigürasyonu için kullanılan alanlar aşağıdaki tabloda görülmektedir.

AlanAçıklama

Ad

(Name)

Sorgu modelinin ad bilgisidir.

Açıklama

(Description)

Sorgu modeline ilişkin açıklamadır.

Şema

(Schema)

Veride yer bulunacak özellikler ve alanların tipi, pattern, min-max gibi özellikleri yönetilir.

Örnek

(Example)

Veri tipinin bir örneği oluşturabilir.


Şema Özelliği ekleme ayarlarını içeren görsele aşağıda yer verilmiştir:


Şema Özelliği oluşturma konfigürasyonu için kullanılan alanlar aşağıdaki tabloda görülmektedir.

AlanAçıklama

Ad

(Name)

Şemanın ad bilgisidir.

Açıklama

(Description)

Şema hakkında açıklama yapılabilir.

Tip

(Type)

Şemanın tipinin belirtildiği alandır.

Format

(Format)

Seçilen tipe göre aktif olan bir alandır. Bazı tipler için seçilebilecek formatlar bulunur:

  • integer
    • int32: İşaretli 32 bit tam sayılar (yaygın olarak kullanılan tam sayı türü).
    • int64: İşaretli 64 bit tam sayılar (uzun tip).
  • number
    • float: Ondalıklı sayılar (6 basamak).
    • double: Ondalıklı sayılar (14 basamak).
  • string
    • byte: Base64 ile kodlanmış karakterler. Örneğin, U3dhZ2dlciByb2Nrcw==
    • binary: Dosyaları tanımlamak için kullanılan ikili veri
    • date: Tam tarih gösterimi. Örneğin, 2017-07-21
    • date-time: Tarih-saat gösterimi. Örneğin, 2017-07-21T17:32:28Z
    • password: Girişi maskelemek için kullanılır.
$Ref Target

Eğer tip alanından $ref seçilirse bu alan aktifleşir.

Başka bir sorgu modelinin referansı verilebilir.

Özellik

(Property is)

Modelin kullanımının zorunlu olup olmadığı belirtilir.

Davranım

(Behaviour)

Şemanın yalnızca okunur/yazılır (Read Only, Write Only) bilgisi belirlenir.

Integer Özellikleri

(Integer Properties)

Tip olarak Integer seçilmiş ise bu alanlar aktif olur:

  • Minimum: Girilebilecek değerlerin en küçüğünü belirlemek içindir.
  • Maximum: Girilebilecek değerlerin en büyüğünü belirlemek içindir.
  • MultipleOf: Girilecek değerlerin bir sayının katı olması isteniyorsa bunu belirlemek içindir.

String Özellikleri

(String Properties)

Tip olarak String seçilmiş ise bu alanlar aktif olur:

  • Desen (Pattern): String değeri için bir normal ifade şablonu tanımlamanıza olanak tanır. Yalnızca bu şablonla eşleşen değerler kabul edilecektir.
  • Minimum Uzunluğu (Min Length): Girilebilecek değerlerin minimum uzunluğunu belirlemek içindir.
  • Maksimum Uzunluğu (Max Length): Girilebilecek değerlerin maksimum uzunluğunu belirlemek içindir.

Enum Değerleri

(Enum Values)

Tip olarak Enum seçilmiş ise bu alan aktif olur.

Modelin olası değerlerininin girildiği alandır.

Örnek

(Example)

Şemayı tarif eden bir örnek verilebilir.