Apinizer, DB-2-API ile teknik bilgi gerektirmeden bile dakikalar içinde veri tabanı işlemi yapan bir REST API'yi oluşturarak yüklemesine olanak sağlar. Aşağıdaki işlemleri destekler:

  • Native SQL deyimleri (SELECT, INSERT, UPDATE, DELETE, PROCEDURE, BATCH INSERT, TRUNCATE)
  • NoSQL işlem tipleri (FIND)
  • Stored Procedure çağırma
  • Cursor sonucunu dönme
  • Batch işlem yapma
  • CRUD işlemleri

Yeni DB-2-API Oluşturma

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

Açılan arayüzde sağ üstteki +Oluştur (Create) tuşuna tıklanır.


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

Endpoint Oluşturma

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


Method/Endpoint tanımlama ekranındaki alanlar doldurularak Kaydet (Save) tuşuna tıklanır.


Endpoint oluşturmak için kullanılan alanlar aşağıdaki tabloda görülmektedir.

Alan

Açıklama

HTTP Metot

(HTTP Method)

REST API'ler için HTTP Metodu seçilir;

GET, POST, PUT, HEAD, OPTIONS, DELETE, PATCH, TRACE, ALL

Ad/URL

(Name/URL)

Method/Endpoint'ye kullanıcı tarafından verilen addır. Arayüzlerde bu ad görünür.

Açıklama 

(Description)

Method/Endpoint'nin tanım bilgisidir. 

Bağlantı Havuzu Tanımı

(Connection Pool Description)

Sorguların işletileceği Veritabanı bağlantısının bilgisidir.

Sorgu Zaman Aşımı

(Timeout)

Sorgu yürütmesinin saniye cinsinden zaman aşımı değeridir.

SQL Deyimi Türü

(Type of SQL Statement)

SQL Deyimi türü bilgisidir;

SELECT, UPDATE, INSERT, DELETE, PROCEDURE, TRUNCATE, BATCH INSERT

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. Ardından parametre için örnek değerleri girerek Dene (Try It) butonuna tıklayarak sorgunuzun doğrulunu kontrol edebilirsiniz.

Örnek sorgu: select * from employees where first_name =:fName . Burada  :fName parametre'dir ve API'ya istek yapacak kullanıcı tarafından gönderilir.

İşlem Tipi

(Operation Type)

NoSQL işlem tipi bilgisidir;

FIND

Sorgu

(Query)

Çalıştırılacak olacak sorgudur. Parametreler, tanımlanabilmeleri için iki süslü parantez içine alınır. Ardından parametre için örnek değerleri girerek Dene (Try It) butonuna tıklayarak sorgunuzun doğrulunu kontrol edebilirsiniz.

Örnek sorgu: { username: {{username}} }. Burada {{username}} parametre'dir ve API'ya istek yapacak kullanıcı tarafından gönderilir.

Parametreler

(Parameters)

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

Yanıt Mesajı Örneği

(Example Response)

Dene (Try It) butonuna tıklandığında dönen yanıt örneğidir. Yanıt olarak sadece tek ve ilk kayıt döner.

Düzenlenebilir bir alandır. Böylelikle, kullanıcı örnek yanıt bilgisini değiştirebilir veya gizli bilgileri kaldırabilir. Bu değişiklik, API Proxy oluşturulup, API tanım dosyasındaki metodun örnek yanıt bilgisini etkiler.  


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.


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.


Bu adımdan sonra yapılabilecekler API Proxy dokümanı ile birebir aynıdır. Detayına gitmek için tıklayınız.

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 linkine tıklayarak açılan pencereden görüntülenir ve yönetilir. Açılan pencere'de 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. Revizyon, Yükleme, Yeniden Yükleme, Kaldırma

API Proxy'i deploy etmek için API Proxy'leri Yönet (Manage API Proxies) linkine tıklanarak deploy simgesine basılır.


Yukarıdaki işlemden sonra onaylama yapmak gereklidir. Yükleme işlemiyle ilgili bilgileri oluşturup (Yükle) Deploy butonuna tıklanır.


DB-2-AP'ye yeni bir Method/Endpoint eklendiğinde ve ya mevcut Method/Endpoint'lerden birisi güncellendiğinde, tüm API Proxy'lerin Yeniden Yüklenmesi gerekir.

Yeni bir Method/Endpoint eklediğinizde ve ya mevcut bir Method/Endpoint'i güncellediğinizde aşağıdaki gibi bir bilgilendirme gelecektir.  


Yeniden Yükle (Redeploy Required) diyerek değişikliklerin API Proxy'lere uygulanması sağlanır.


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.


DB-2-API sayfasından API Proxy'nin ismindeki link tıklanarak API Proxy'e gidilir.


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.


DB-2-API Silme

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