Script-2-API
Script-2-API ekranı, function-as-a-service yaklaşımıyla REST API oluşturmaya izin verir. Endpoint'lere ait iş mantıkları Javascript veya Groovy diliyle yazılır.
Script-2-API'nin çalışma mantığı şu şekildedir; gelen mesajın öğeleri (başlık, parametre, gövde) seçilen script dili ile işlenip sonucunu istemciye gönderilir.
Gelen istek mesajın orijinal hali üzerinde değişiklik yapılamaz, bu veriler üzerinde sadece okuma yapılabilir. İstemciye dönecek yanıt ise script içerisinde hazırlanır.
Yeni Script-2-API Oluşturma
Ana menüde Geliştirme → API Oluşturucu → Script-2-API öğesi seçilir.
Açılan arayüzde sağ üstteki +Oluştur tuşuna tıklanır.
Yeni oluşturulacak API için aşağıdaki alanlar doldurularak sağ üstteki →Kaydet ve Devam tuşuna tıklanmasıyla API oluşturma işi başlamış olur.
API kaydedildikten sonra API'ye endpoint tanımlanmasına başlanır. Hiç endpoint yoksa ilk defa eklemek için API içerisinde ekle tuşuna basılır, eğer en az bir tane varsa endpoint'ler bölümünde çıkan ekle tuşuna basılır.
Endpoint Oluşturma
Endpoint tanımlamak için aşağıdaki bilgiler girilir:
Endpoint oluşturma konfigürasyonu 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) | Endpoint erişim adresidir. API Proxy oluşturulduğunda endpointe bu adres üzerinden erişilir |
Açıklama (Description) | API endpoint'inin tanım bilgisidir. |
Script Tipi (Script Type) | Yazılacak olan Script'in tipidir. Javascript veya Groovy olabilir. |
Değişkenler (Variables) | İstek ve yanıt hattında erişimi gerçekleştirebilecek read-only ve write-only değişkenlerin listesidir. İlgili değişkene tıklandığında, değişken Script alanında imlecin bulunduğu noktaya eklenir. |
Script (Script) | Çalıştırılacak olan script bilgisidir. |
Deneme Tuşu (Try It) | Çalıştırılacak olan scriptin denemesinin yapılabilmesi için yeni bir pencere açılmasını sağlar. |
Değişkenler (Variables)
Yapılacak olan okuma ve oluşturma işlemleri için mesajın başlık, parametre ve gövde kısımlarına script üzerinde erişim için çeşitli anahtar kelimeler kullanılmıştır. Bu alanlar ve tipleri aşağıdaki tabloda özetlenmiştir:
| Client → Apinizer | Veri Tipi | İşlem | Apinizer → Client | Veri Tipi | İşlem | |
|---|---|---|---|---|---|---|
| Başlık | requestHeaderMapFromClient | Map<String, String> | Okuma | responseHeaderMapToClient | Map<String, String> | Yazma |
| Parametre | requestUrlParamMapFromClient | Map<String, String> | Okuma | - | Map<String, String> | - |
| Gövde | requestBodyTextFromClient | String | Okuma | responseBodyTextToClient | String | Yazma |
| Durum Kodu | - | - | - | statusCodeToClient | Integer | Yazma |
| Mesaj Bilgisi | contextValues | String | Okuma | contextValues | String | Okuma |
| Özel Değişken | customVariableMap | Map<String, String> | Okuma, Yazma | customVariableMap | Map<String, String> | Okuma, Yazma |
Script tipi Groovy ise;
- Mesaj gövdesi JSON olan durumda JsonSlurper,
- Mesaj gövdesi XML olan durumda XMLSlurper
kullanılması mesaj işleme işlemini oldukça kolaylaştırır.
Script-2-API'den API Proxy Oluşturma
API'nin tanımlamaları bittikten sonra sıra bu API'yi API Proxy olarak açmaya gelir.
Script-2-API'den API Proxy oluşturmak için Script-2-API ile oluşturulan API'nin en az bir tane endpoint'i olmalıdır.
Script-2-API'yi API Proxy olarak erişime açabilmek için aşağıdaki görselde Proxy Oluştur (Create Proxy) tuşuna basılır.
Gelen ekranda API Proxy için gerekli alanları girerek Kaydet butonuna tıklayarak API Proxy oluşturulur.
Bu adımdan sonra yapılabilecekler API Proxy dokümanı ile aynıdır. Detaylı bilgi için API Proxy Oluşturma sayfasını inceleyebilirsiniz.
Bir Script-2-API için birden fazla API Proxy oluşturabilirsiniz.
Yükle (Deploy)/Yeniden Yükle (Redeploy)
Script-2-API ile oluşturulan API Proxy'leri, API Proxy'ler sayfasından veya Script-2-API sayfasında ilgili API'yi seçerek yükleme durumunu yönetebilirsiniz.
Script-2-API sayfasından yönetmek için sayfanın üstünde yer alan API Proxy'leri Yönet (Mange API Proxies) linkine tıklanınca açılan pencereden faydalanılır. Açılan pencerede bu API'den oluşturulan API Proxy'ler için Yükleme (Deploy), Yeniden Yükleme (Redeploy) ve Kaldırma (Undeploy) işlemlerini yapabilirsiniz. Bu konuyla ilgili daha detaylı bilgi almak için Revizyon, Yükleme, Yeniden Yükleme, Kaldırma sayfalarımızı ziyaret edebilirsiniz.
Yukarıdaki işlemden sonra onaylama yapmak gereklidir. Yükleme işlemiyle ilgili bilgileri oluşturup (Yükle) Deploy butonuna tıklanır.
Script-2-API'ye yeni bir endpoint eklendiğinde veya endpoint içinde değişiklik yapıldığında değişikliğin geçerli olabilmesi için bu API'den oluşturulan tüm API Proxy'lerin yeniden yüklenmesi gerekir.
Yeni bir endpoint eklediğinizde ve ya mevcut bir endpoint'i güncellediğinizde aşağıdaki gibi bir bilgilendirme gelecektir.
Yeniden Yükle (Redeploy) 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.
Script-2-API sayfasından API Proxy'nin ismine tıklanarak API Proxy'e gidilir.
Benzer şekilde, API Proxy sayfasından Script-2-API sayfasına gitmek için aşağıdaki gibi API Proxy'deki Script-2-API ismine tıklayarak gidilir.
Script-2-API Silme
Bir Script API silindiğinden ona bağlı olan tüm API Proxy'ler önce kaldırılır (undeploy) sonra silinir.