#REST API Veri Kaynağı

#Giriş

Bu eklenti, REST API kaynaklarından gelen verileri sorunsuz bir şekilde entegre etmenizi sağlar.

#Kurulum

Bu bir ticari eklentidir ve eklenti yöneticisi aracılığıyla yüklenip etkinleştirilmesi gerekir.

#REST API Kaynağı Ekleme

Eklentiyi etkinleştirdikten sonra, veri kaynağı yönetimi bölümündeki "Yeni ekle" açılır menüsünden REST API'yi seçerek bir REST API kaynağı ekleyebilirsiniz.

REST API kaynağını yapılandırın.

#Koleksiyon Ekleme

NocoBase'de, bir RESTful kaynak bir koleksiyona eşlenir; örneğin, bir Kullanıcılar koleksiyonu.

GET /users
POST /users
GET /users/1
PUT /users/1
DELETE /users/1

Bu API uç noktaları NocoBase'de şu şekilde eşlenir:

GET /users:list
POST /users:create
POST /users:get?filterByTk=1
POST /users:update?filterByTk=1
POST /users:destroy?filterByTk=1

NocoBase API tasarım spesifikasyonları hakkında kapsamlı bir rehber için API belgelerine başvurabilirsiniz.

Detaylı bilgi için "NocoBase API - Çekirdek" bölümünü inceleyin.

Bir REST API veri kaynağı için koleksiyon yapılandırması şunları içerir:

#Listeleme

Kaynakların bir listesini görüntülemek için arayüzü eşleyin.

#Getir

Kaynak detaylarını görüntülemek için arayüzü eşleyin.

#Oluştur

Bir kaynak oluşturmak için arayüzü eşleyin.

#Güncelle

Bir kaynağı güncellemek için arayüzü eşleyin.

#Sil

Bir kaynağı silmek için arayüzü eşleyin.

Listeleme ve Getir arayüzlerinin her ikisinin de yapılandırılması zorunludur.

#API Hata Ayıklama

#İstek Parametre Entegrasyonu

Örnek: Listeleme API'si için sayfalama parametrelerini yapılandırın. Üçüncü taraf API'si yerel olarak sayfalama desteklemiyorsa, NocoBase alınan liste verilerine göre sayfalama yapacaktır.

Lütfen dikkat, yalnızca arayüze eklenen değişkenler geçerli olacaktır.

Hata ayıklamak ve yanıtı görüntülemek için "Deneyin" (Try it out) düğmesine tıklayabilirsiniz.

#Yanıt Formatı Dönüşümü

Üçüncü taraf API'sinin yanıt formatı NocoBase standardında olmayabilir ve ön uçta doğru şekilde görüntülenebilmesi için dönüştürülmesi gerekir.

Çıktının NocoBase standardına uygun olmasını sağlamak için dönüşüm kurallarını üçüncü taraf API'sinin yanıt formatına göre ayarlayın.

Hata ayıklama süreci açıklaması

#Değişkenler

REST API veri kaynağı, API entegrasyonu için üç tür değişkeni destekler:

• Özel veri kaynağı değişkenleri
• NocoBase istek değişkenleri
• Üçüncü taraf yanıt değişkenleri

#Özel Veri Kaynağı Değişkenleri

#NocoBase İsteği

• Params: URL sorgu parametreleri (Search Params), arayüze göre değişiklik gösterir.
• Headers: Özel istek başlıkları, öncelikli olarak NocoBase'den belirli X- bilgilerini sağlar.
• Body: İstek gövdesi.
• Token: Mevcut NocoBase isteği için API anahtarı (token).

#Üçüncü Taraf Yanıtları

Şu anda yalnızca yanıt gövdesi mevcuttur.

Her arayüz için mevcut değişkenler aşağıdadır:

#Listeleme

#Getir

#Oluştur

#Güncelle

#Sil

#Alan Yapılandırması

Uyarlanan kaynağın CRUD arayüz verilerinden alan meta verileri (Alanlar), koleksiyonun alanları olarak çıkarılır.

Alan meta verilerini çıkarın.

Alanlar ve önizleme.

Alanları düzenleyin (diğer veri kaynaklarına benzer şekilde).

#REST API Veri Kaynağı Blokları Ekleme

Koleksiyon yapılandırıldıktan sonra, arayüze bloklar ekleyebilirsiniz.