Ana içeriğe geç

JSON Şemasının Tanımı

Bu belgede Entegrasyon modülünün JSON şemasının yapısı açıklanmaktadır.

Genel Yapı​

JSON şeması, her bir nesnenin ya bir düğüm (node) ya da bir sekme (tab) olduğu bir nesne dizisidir:

[
  {
    "label": "Merhaba Dünya!",
    "id": "1f24387b252057fe",
    "type": "tab",
    "disabled": false
  },
  {
    "name": "çalıştır",
    "id": "b51ab819b83e1915",
    "type": "inject",
    "x": 46.96875,
    "y": 99.51171875,
    "z": "1f24387b252057fe",
    "wires": [
      [
        "bd07e1ff0aedba0b"
      ]
    ]
  },
  {
    "id": "2b524ca59e4ed633",
    "type": "debug",
    "name": "hata ayıklama",
    "x": 610.05078125,
    "y": 98.59765625,
    "z": "1f24387b252057fe",
    "wires": []
  },
  {
    "name": "fonksiyon",
    "func": "msg.payload = 'Dünya'\n\nreturn msg;",
    "id": "bd07e1ff0aedba0b",
    "type": "function",
    "x": 229.62890625,
    "y": 98.8515625,
    "z": "1f24387b252057fe",
    "wires": [
      [
        "2e1172b330c69aeb"
      ]
    ]
  },
  {
    "id": "2e1172b330c69aeb",
    "type": "template",
    "name": "şablon",
    "x": 418.66796875,
    "y": 98.19140625,
    "z": "1f24387b252057fe",
    "syntax": "mustache",
    "template": "Merhaba {{payload}} !",
    "output": "str",
    "wires": [
      [
        "2b524ca59e4ed633"
      ]
    ]
  }
]

Düğümlerin Temel Parametreleri​

Çoğu düğüm aşağıdaki ortak parametrelere sahiptir:

  • id (string) - düğümün benzersiz tanımlayıcısı
  • type (string) - düğümün türü (örneğin, "inject", "function", "template")
  • name (string) - düğümün görüntülenen adı
  • x, y (number) - düğümün çalışma alanındaki koordinatları
  • z (string) - düğümün ait olduğu sekmenin tanımlayıcısı
  • wires (array) - çıkışın bağlı olduğu düğümlerin tanımlayıcılarının dizisi

Sistem Düğümleri​

"tab" Düğümü (sekme)​

tab türündeki düğüm, bir grup düğüm için bir konteynerdir ve arayüzde sekme olarak görsel olarak gösterilir.

Parametreler:

  • label (string) - sekmenin görüntülenen adı
  • id (string) - sekmenin benzersiz tanımlayıcısı
  • type (string) - düğüm türü (tab)
  • disabled (boolean) - sekmenin devre dışı olup olmadığı

"debug" Düğümü (hata ayıklama)​

debug türündeki düğüm, hata ayıklama paneline mesajlar göndermek için kullanılır.

Temel Parametreler:

  • id (string) - düğümün benzersiz tanımlayıcısı
  • type (string) - düğüm türü (debug)
  • name (string) - düğümün görüntülenen adı
  • x, y (number) - düğümün çalışma alanındaki koordinatları
  • z (string) - düğümün ait olduğu sekmenin tanımlayıcısı
  • wires (array) - çıkışlar için bağlantılar dizisi

Düğümler Arasındaki Bağlantılar​

wires parametresi, düğümler arasındaki bağlantıları tanımlar. Dizi içindeki her bir eleman, bir düğümün çıkışına karşılık gelir ve bu çıkışa bağlı düğümlerin tanımlayıcılarının dizisini içerir.

Örnek:

"wires": [
  [
    "bd07e1ff0aedba0b"
  ]
]

Düğüm Parametrelerinin Tanımı​

"inject" Düğümü (enjektör)​

inject düğümü, mesajları manuel olarak oluşturmak ve akışa göndermek için kullanılır.

Temel Parametreler:

  • id (string) - düğümün benzersiz tanımlayıcısı
  • type (string) - düğüm türü (inject)
  • name (string) - düğümün görüntülenen adı
  • x, y (number) - düğümün çalışma alanındaki koordinatları
  • z (string) - düğümün ait olduğu sekmenin tanımlayıcısı
  • wires (array) - çıkışlar için bağlantılar dizisi

"function" Düğümü (fonksiyon)​

function türündeki düğüm, rastgele JavaScript kodu çalıştırmaya olanak tanır.

Temel Parametreler:

  • id (string) - düğümün benzersiz tanımlayıcısı
  • type (string) - düğüm türü (function)
  • name (string) - düğümün adı
  • func (string) - çalıştırılan kod
  • x, y (number) - düğümün çalışma alanındaki koordinatları
  • z (string) - düğümün ait olduğu sekmenin tanımlayıcısı
  • wires (array) - çıkışlar için bağlantılar dizisi

"template" Düğümü (şablon)​

template türündeki düğüm, şablonlar kullanarak mesajları dönüştürmek için kullanılır.

Temel Parametreler:

  • id (string) - düğümün benzersiz tanımlayıcısı
  • type (string) - düğüm türü (template)
  • name (string) - düğümün adı
  • syntax (string) - şablonun sözdizimi (mustache veya plain)
  • template (string) - mesaj şablonu
  • output (string) - çıktı türü (plain, json veya yaml)
  • x, y (number) - düğümün çalışma alanındaki koordinatları
  • z (string) - düğümün ait olduğu sekmenin tanımlayıcısı
  • wires (array) - çıkışlar için bağlantılar dizisi

"interval-node" Düğümü (aralık)​

interval-node türündeki düğüm, belirli zaman aralıklarıyla mesajlar üretmek için kullanılır.

Temel Parametreler:

  • id (string) - düğümün benzersiz tanımlayıcısı
  • type (string) - düğüm türü (interval-node)
  • name (string) - düğümün adı
  • interval (number) - mesajlar arasındaki dakika cinsinden aralık
  • x, y (number) - düğümün çalışma alanındaki koordinatları
  • z (string) - düğümün ait olduğu sekmenin tanımlayıcısı
  • wires (array) - çıkışlar için bağlantılar dizisi

"switch" Düğümü (anahtar)​

switch türündeki düğüm, mesajları koşullara bağlı olarak farklı yollarla yönlendirmek için kullanılır.

Temel Parametreler:

  • id (string) - düğümün benzersiz tanımlayıcısı
  • type (string) - düğüm türü (switch)
  • name (string) - düğümün adı
  • property (string) - kontrol edilecek mesaj özelliği
  • rules (array) - yönlendirme kurallarının dizisi
  • outputs (number) - çıkış portlarının sayısı
  • checkall (string) - tüm kuralları kontrol et (true veya false)
  • repair (boolean) - geçersiz mesajları düzelt
  • x, y (number) - düğümün çalışma alanındaki koordinatları
  • z (string) - düğümün ait olduğu sekmenin tanımlayıcısı
  • wires (array) - çıkışlar için bağlantılar dizisi

"split" Düğümü (bölücü)​

split türündeki düğüm, mesajları birden fazla parçaya ayırmak için kullanılır.

Temel Parametreler:

  • id (string) - düğümün benzersiz tanımlayıcısı
  • type (string) - düğüm türü (split)
  • name (string) - düğümün adı
  • property (string) - bölünecek mesaj özelliği
  • propertyType (string) - özellik türü (msg, flow, global)
  • splt (string) - dizeler için ayırıcı
  • spltType (string) - ayırıcı türü (str, bin)
  • arraySplt (number) - diziler için parça boyutu
  • arraySpltType (string) - dizilerin bölünme türü (len, index)
  • stream (boolean) - akış modunda işleme
  • x, y (number) - düğümün çalışma alanındaki koordinatları
  • z (string) - düğümün ait olduğu sekmenin tanımlayıcısı
  • wires (array) - çıkışlar için bağlantılar dizisi

"http in" Düğümü (HTTP girişi)​

http in türündeki düğüm, HTTP uç noktaları oluşturmak ve gelen HTTP isteklerini almak için kullanılır.

Temel Parametreler:

  • id (string) - düğümün benzersiz tanımlayıcısı
  • type (string) - düğüm türü (http in)
  • name (string) - düğümün adı (isteğe bağlı)
  • url (string) - uç noktanın URL yolu
  • method (string) - HTTP yöntemi (get, post, put, delete, patch)
  • x, y (number) - düğümün çalışma alanındaki koordinatları
  • z (string) - düğümün ait olduğu sekmenin tanımlayıcısı
  • wires (array) - istekleri işlemek için bağlantılar dizisi

"http request" Düğümü (HTTP isteği)​

http request türündeki düğüm, çıkış HTTP isteklerini gerçekleştirmek için kullanılır.

Temel Parametreler:

  • id (string) - düğümün benzersiz tanımlayıcısı
  • type (string) - düğüm türü (http request)
  • name (string) - düğümün adı
  • url (string) - istek için URL adresi
  • method (string) - HTTP yöntemi (GET, POST, PUT, DELETE, vb.)
  • ret (string) - yanıt formatı (obj, txt, bin)
  • headers (array) - istek başlıklarının dizisi
  • paytoqs (string) - yükü nereye yerleştireceği (body, query)
  • useAuth (boolean) - kimlik doğrulama kullan
  • authType (string) - kimlik doğrulama türü (basic, bearer)
  • x, y (number) - düğümün çalışma alanındaki koordinatları
  • z (string) - düğümün ait olduğu sekmenin tanımlayıcısı
  • wires (array) - yanıtı işlemek için bağlantılar dizisi

"http response" Düğümü (HTTP yanıtı)​

http response türündeki düğüm, istemciye HTTP yanıtları göndermek için kullanılır.

Temel Parametreler:

  • id (string) - düğümün benzersiz tanımlayıcısı
  • type (string) - düğüm türü (http response)
  • name (string) - düğümün adı
  • statusCode (number) - HTTP yanıt durum kodu
  • x, y (number) - düğümün çalışma alanındaki koordinatları
  • z (string) - düğümün ait olduğu sekmenin tanımlayıcısı
  • wires (array) - bağlantılar dizisi (genellikle boştur)

"cms-events" Düğümü​

Bu düğüm, Events modülünden olayları izlemeye ve bunları akışa atmaya olanak tanır.

Temel Parametreler:

  • id (string) - düğümün benzersiz tanımlayıcısı
  • type (string) - düğüm türü (cms-events)
  • name (string) - düğümün adı
  • eventMarker (string) - olayın tanımlayıcısı
  • property (string) - işlenecek mesaj özelliği
  • targetType (string) - işleme hedefinin türü (msg, flow, global)
  • x, y (number) - düğümün çalışma alanındaki koordinatları
  • z (string) - düğümün ait olduğu sekmenin tanımlayıcısı
  • wires (array) - daha fazla işleme için bağlantılar dizisi

"admin-api" Düğümü (Admin API)​

Bu düğüm, çeşitli API'lerle etkileşimde bulunmayı sağlar.

Temel Parametreler:

  • id (string) - düğümün benzersiz tanımlayıcısı
  • type (string) - düğüm türü (admin-api)
  • name (string) - düğümün adı
  • path (string) - API uç noktasının yolu
  • method (string) - HTTP yöntemi (post, get, put, delete)
  • operation (string) - kontrolörün işlem tanımlayıcısı
  • data (string) - JSON formatında istek verileri
  • wires (array) - yanıtı işlemek için bağlantılar dizisi