Ana içeriğe atla
Aşağıdaki işlemleri destekler:

Native SQL Deyimleri

SELECT, INSERT, UPDATE, DELETE, PROCEDURE, BATCH INSERT, TRUNCATE işlemlerini destekler.

NoSQL İşlemleri

FIND işlem tipi desteği sağlar.

Stored Procedure

Stored Procedure çağırma desteği sunar.

Cursor Desteği

Cursor sonucunu dönebilir.

Batch İşlemler

Batch işlem yapma desteği sağlar.

CRUD İşlemleri

Tüm CRUD operasyonlarını destekler.

Yeni DB-2-API Oluşturma

1

Menüden DB-2-API Sayfasına Gidin

Ana menüde Geliştirme → API Oluşturucu → DB-2-API (Development → API Creator → DB-2-API) ögesi seçilir.
2

Yeni API Oluşturun

Açılan arayüzde sağ üstteki +Oluştur (Create) tuşuna tıklanır.DB-2-API Oluştur butonu
3

API Bilgilerini Doldurun

Yeni oluşturulacak API için gerekli alanlar doldurularak sağ üstteki →Kaydet ve Devam (Save and Next) tuşuna tıklanmasıyla API oluşturma işi başlamış olur.DB-2-API bilgilerini doldurma

Endpoint Oluşturma

1

Endpoint Ekle

Gelen ekranda Ekle (Add) tuşuna tıklayarak API’ye Method/Endpoint eklenir.Endpoint ekle
2

Endpoint Bilgilerini Doldurun

Method/Endpoint tanımlama ekranındaki alanlar doldurularak Kaydet tuşuna tıklanır.Endpoint tanımlama
Endpoint oluşturmak için kullanılan alanlar aşağıda kategorilere ayrılarak açıklanmıştır:

HTTP Metot

Alan: HTTP Metot (HTTP Method)REST API’ler için HTTP Metodu seçilir: GET, POST, PUT, HEAD, OPTIONS, DELETE, PATCH, TRACE, ALL

Ad/URL

Alan: Ad/URL (Name/URL)Method/Endpoint’ye kullanıcı tarafından verilen addır. Arayüzlerde bu ad görünür.

Açıklama

Alan: AçıklamaMethod/Endpoint’nin tanım bilgisidir.

Bağlantı Havuzu

Alan: Bağlantı Havuzu Tanımı (Connection Pool Description)Sorguların işletileceği Veritabanı bağlantısının bilgisidir.

Sorgu Zaman Aşımı

Alan: Sorgu Zaman Aşımı (Timeout)Sorgu yürütmesinin saniye cinsinden zaman aşımı değeridir.

SQL Deyimi Türü

Alan: SQL Deyimi Türü (Type of SQL Statement)SQL Deyimi türü bilgisidir: SELECT, UPDATE, INSERT, DELETE, PROCEDURE, TRUNCATE, BATCH INSERT

SQL Deyimi

Alan: SQL Deyimi (SQL)Çalıştırılacak olacak SQL deyimidir. Parametreler, tanımlanabilmeleri için iki nokta üst üste (:) önekiyle boşluk bırakılmadan yazılmalıdır.Örnek sorgu:
select * from employees where first_name = :fName
Burada :fName parametre’dir ve API’ya istek yapacak kullanıcı tarafından gönderilir.
Ardından parametre için örnek değerleri girerek Dene (Try It) butonuna tıklayarak sorgunuzun doğrulunu kontrol edebilirsiniz.

İşlem Tipi

Alan: İşlem Tipi (Operation Type)NoSQL işlem tipi bilgisidir: FIND

Sorgu

Alan: Sorgu (Query)Çalıştırılacak olacak sorgudur. Parametreler, tanımlanabilmeleri için iki süslü parantez içine alınır.Örnek sorgu:
{ username: {{username}} }
Burada {{username}} parametre’dir ve API’ya istek yapacak kullanıcı tarafından gönderilir.
Ardından parametre için örnek değerleri girerek Dene (Try It) butonuna tıklayarak sorgunuzun doğrulunu kontrol edebilirsiniz.

Parametreler

Alan: Parametreler (Parameters)SQL Sorgunuzda :fName gibi bir parametre mevcutsa Parametreler (Parameters) tablosu açılır. Burada parametrenin:
  • Veri Tipi
  • Formatı
  • Yineleme Tipi
  • Parametre Tipi
  • Örnek Değer’ler
girilir.
Daha sonra Dene butonuna tıklanarak “Yanıt Mesaj Örneği” bu verilere göre gelir.

SQL’i Test Etme

Endpoint’e istek gönderildiğinde nasıl bir sonucun alınacağı görülmek istenebilir. Eğer endpoint için çalıştırılacak sorgunun parametreleri varsa test verileri (Test Value) girilerek Dene (Try It) butonuna basılır. Test sonucu dönen şablon, Apinizer’da stabil olan Response nesnesidir. Eğer sorguyla eşleşen birden fazla kayıt varsa sadece ilk kayıt örnek yanıt içinde verilmektedir. SQL test etme
Test için null değer gönderilmek istenirse, parametre olarak null yazılması yeterlidir.

DB-2-API’den API Proxy Oluşturma

En az bir tane Method/Endpoint olduğunda API Proxy Oluştur (Create API Proxy) tuşuna tıklayarak DB-2-API için bir API Proxy oluşturulur.
DB-2-API’den API Proxy oluşturmak için en az bir Method/Endpoint olmalıdır.
Gelen ekranda API Proxy için gerekli alanları girerek Kaydet (Save) butonuna tıklayarak API Proxy oluşturulur. API Proxy oluşturma Bu adımdan sonra yapılabilecekler API Proxy dokümanı ile birebir aynıdır. Detayına gitmek için API Proxy Oluşturma sayfasına bakabilirsiniz.
Bir DB-2-API’dan birden fazla API Proxy oluşturabilirsiniz.

Yükle (Deploy)/Yeniden Yükle (Redeploy)

DB-2-API’deki API Proxy’leri görüntülemek ve yönetmek için API Proxy’leri Yönet (Manage API Proxies) linkine tıklayarak açılan pencereden görüntülenir ve yönetilir. Açılan pencerede DB-2-API ile oluşturulan API Proxy’ler Yükle/Kaldır ve Yeniden Yükle işlemleri bu bölümde yapılır. API Proxy’i deploy etmek için API Proxy’leri Yönet (Manage API Proxies) linkine tıklanarak deploy simgesine basılır. API Proxy yönetme Yukarıdaki işlemden sonra onaylama yapmak gereklidir. Yükleme işlemiyle ilgili bilgileri oluşturup (Yükle) Deploy butonuna tıklanır. Deploy ekranı DB-2-API’ye yeni bir Method/Endpoint eklendiğinde veya mevcut Method/Endpoint’lerden birisi güncellendiğinde, tüm API Proxy’lerin yeniden yüklenmesi gerekir. Yeni bir Method/Endpoint eklediğinizde veya mevcut bir Method/Endpoint’i güncellediğinizde aşağıdaki gibi bir bilgilendirme gelecektir. Yeniden yükleme bildirimi Yeniden Yükle (Redeploy Required) diyerek değişikliklerin API Proxy’lere uygulanması sağlanır. Redeploy ekranı Yukarıdaki işlemden sonra onaylama yapmak gereklidir. Yeniden yükleme işlemiyle ilgili bilgileri oluşturup (Yeniden Yükle) Redeploy butonuna tıklanır. Redeploy onay ekranı DB-2-API sayfasından API Proxy’nin ismindeki link tıklanarak API Proxy’e gidilir. DB-2-API'dan API Proxy'ye link Benzer şekilde, API Proxy sayfasından DB-2-API sayfasına gitmek için aşağıdaki gibi API Proxy’deki DB-2-API ismine tıklayarak gidilir. API Proxy'den DB-2-API'ye link

DB-2-API Silme

Bir DB-2-API silindiğinde ona bağlı olan tüm API Proxy’ler önce kaldırılır (Undeploy) sonra silinir.