API Creator ile Veri Tabanından API oluşturma
Aşağıdaki işlemleri destekler:
SELECT, INSERT, UPDATE, DELETE, PROCEDURE, BATCH INSERT, TRUNCATE işlemlerini destekler.
FIND işlem tipi desteği sağlar.
Stored Procedure çağırma desteği sunar.
Cursor sonucunu dönebilir.
Batch işlem yapma desteği sağlar.
Tüm CRUD operasyonlarını destekler.
Yeni DB-2-API Oluşturma
DB-2-API oluşturma iki adımlı bir sihirbazdır: Tanım ve Gözden Geçir.
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 Yeni tuşuna tıklanır.
Tanım adımında API'nin Ad (zorunlu, benzersiz olmalı) ve Açıklama alanları doldurulur ve Devam Et tuşuna tıklanır. Sağdaki panel DB-2-API'nin nasıl çalıştığını anlatır: istemci Apinizer üzerinden bir REST API çağırır, Apinizer SQL deyimini veri tabanında çalıştırır ve OpenAPI tanımı otomatik oluşturulur.
Gözden geçir adımında tip, ad ve açıklama gösterilir. DB-2-API Oluştur tuşuna tıklanınca API oluşturulur ve endpoint'lerin eklendiği editör açılır.
Editörde solda API (ad, açıklama ile uç nokta, bağlantı havuzu ve API Proxy sayıları; düzenleme simgesi ad ve açıklamayı değiştirir) ve altında Endpoint'ler listesi, sağda ise seçili endpoint görünür. Üstte Değişkenler ve Spec'leri göster simgeleri ile ⋯ menüsü bulunur. ⋯ menüsünde API Proxy (API Proxy Oluştur, Proxyleri Yönet), Aktarım (Dışa Aktar, Çoğalt), Geçmiş (Denetim ve Geri Yükleme) ve Sil yer alır.
Endpoint Oluşturma
Endpoint'ler listesindeki Ekle (+) tuşuna, liste boşsa Uç nokta ekle tuşuna tıklayarak API'ye Method/Endpoint eklenir. Liste endpoint adına veya SQL'e göre aranabilir.
Method/Endpoint tanımlama formundaki alanlar doldurularak Kaydet tuşuna tıklanır. Var olan bir endpoint'i sonra değiştirmek için endpoint seçilir ve Yapılandır tuşuna tıklanır.
Endpoint oluşturmak için kullanılan alanlar aşağıda kategorilere ayrılarak açıklanmıştır:
Temel Bilgiler
Alan: HTTP Metot (HTTP Method)
REST API'ler için HTTP Metodu seçilir: GET, POST, PUT, HEAD, OPTIONS, DELETE, PATCH, TRACE, ALL, QUERY
Alan: Ad/URL (Name/URL)
Method/Endpoint'ye kullanıcı tarafından verilen addır. Arayüzlerde bu ad görünür.
Alan: Açıklama
Method/Endpoint'nin tanım bilgisidir.
Veritabanı Bağlantısı
Alan: Bağlantı Havuzu Tanımı (Connection Pool Description)
Sorguların işletileceği Veritabanı bağlantısının bilgisidir.
Alan: Sorgu Zaman Aşımı (Timeout)
Sorgu yürütmesinin saniye cinsinden zaman aşımı değeridir.
SQL İşlemleri
Alan: SQL Deyimi Türü (Type of SQL Statement)
SQL Deyimi türü bilgisidir: SELECT, UPDATE, INSERT, DELETE, PROCEDURE, TRUNCATE, BATCH INSERT
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 Bu sorguyu dene (Try this query) butonuna tıklayarak sorgunuzun doğrulunu kontrol edebilirsiniz.
NoSQL İşlemleri
Alan: İşlem Tipi (Operation Type)
NoSQL işlem tipi bilgisidir: FIND
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 Bu sorguyu dene (Try this query) 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.
Parametreler Parametreleri SQL'den eşitle (Sync parameters from SQL) butonuyla deyimden de doldurulabilir. Daha sonra Bu sorguyu 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 Bu sorguyu dene (Try this query) butonuna basılır.
Gerçek bir istek göndermek için endpoint'in üstündeki Dene (Try it) tuşunu kullanın. İstek, bu DB-2-API'den oluşturulmuş bir API Proxy üzerinden gider; bu yüzden en az bir API Proxy bulunmalı ve yüklenmiş olmalıdı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 ⋯ menüsünden API Proxy → API Proxy Oluştur (Create API Proxy) seçeneğiyle 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. O zamana kadar menü ögesi pasiftir ("Önce bir uç nokta ekleyin.").
API Proxy Oluştur penceresinde Proxy adı'nı girin, İstemci Rotası'nı (göreli yollar, metotlar, host'lar ve başlıklar; en az birini seçin) belirleyin ve Yüklenecek ortamlar altında yüklenecek ortamları seçin. Oluştur ve yükle tuşuna tıklamak API Proxy'yi oluşturur ve seçili ortamlara yükler. Hiçbir ortam seçmezseniz API Proxy oluşturulur ama yüklenmez.
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 ⋯ menüsünden API Proxy → Proxyleri Yönet (Manage API Proxies) seçeneğine 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 Proxyleri Yönet penceresi açılarak 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-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ü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ğinde ona bağlı olan tüm API Proxy'ler önce kaldırılır (Undeploy) sonra silinir.