Geliştirme Sekmesi (Development Tab)
Bu sekmede, seçilen API Proxy için politikalar, protokol dönüşümü ayarları ve metot/endpoint yönetimi işlemleri yapılabilir.
Metot/Endpoint İşlemleri
Her API Proxy, önüne koyulduğu Backend API'nin metot/endpoint'leri için vekil olarak çalışan kendi metot/endpoint'lerine sahiptir.
Eğer API Proxy, API Tanım Belgesi Editörü ile oluşturulmuş olan bir API Tanım Dosyası kullanılarak, WSDL, Swagger ya da OpenAPI dosyasının adresi verilerek ya da böyle bir dosya yüklenerek oluşturulmuşsa, bu dosyada var olan metot/endpoint'lerin her birisi için API Proxy'de aynı adlı bir metot/endpoint otomatik olarak oluşturulur.
Kullanıcılar aşağıdaki muhtemel nedenlerden dolayı metot/endpoint'lere yenilerini eklemek, var olanları güncellemek, silmek ya da belirli veya belirsiz bir süre için kullanıma kapatmak isteyebilirler:
- Backend API'ye bir ya da daha fazla yeni metot/endpoint eklenmesi
- Backend API'den bir ya da daha fazla metot/endpoint silinmesi
- Backend API'deki bir ya da daha fazla metot/endpoint'in adının ya da HTTP metodunun istemcilerden saklanmak istenmesi
- Backend API'deki bir ya da daha fazla metot/endpoint'in istemcilerin erişimine tamamen ya da geçici bir süreyle kapatılmak istenmesi
Metot/Endpoint Seçme
Metot/endpoint listesinde, herhangi bir metodun adına tıklandığında o metot seçilmiş olur ve arayüz buna göre güncellenir.
- Listede, seçilmiş olan metot/endpoint'i belli edecek şekilde renk değişir.
- Üst orta bölümde seçilmiş olan metot/endpoint'in hangisi olduğu gösterilir.
- Alt orta bölümde ise bu metot/endpoint için yapılabilecek işlemlerin bağlantıları görüntülenir.
- Sağ tarafta ise seçilen metot/enpoint'in Backend API'nin hangi metot/endpoint ile ilişkili olduğu görünür.
REST Endpoint Ayarları Ekleme ve Güncelleme
REST tipindeki API Proxylerde endpoint ekleme ve güncelleme işlemi yapılabilir. SOAP, GRPC ve WEBSOCKET tipindeki API Proxylerde ve Connectorler ile oluşturulmuş veya Reverse Proxy tipindeki API Proxylerde endpoint eklenmesine izin verilmez.
Uç Noktayı Düzenle (Edit Endpoint) bağlantısına tıklanınca açılan penceredeki bilgiler ile ekle tuşuna basılınca açılan penceredeki bilgiler aynı olup, görseline aşağıda yer verilmiştir:
| Alan | Açıklama |
|---|---|
Tanım Dosyasında Gösterme (Hide in Spec File) | Bu seçenek seçilirse bu metot Tanım Dosyasında gösterilmez. |
İndirmeyi Etkinleştir (Enable Download) | API Metodundan/Endpointinden dönen sonuç Byte Array tipinde ise sonucun dosya olarak ele alınması için bu seçenek işaretlenir. Aksi halde içerik encoded text olarak istemciye döner. Sonucun Byte Array olup olmadığına karar vermek için ise Content Type Header değerinin sistem ayarlarındaki "Byte Array Tipleri" listesinde yer alıp almadığına bakılır. Eğer bu listede yer alıyorsa sonucun Byte Array tipinde olduğuna karar verilir. |
Re-Parse'da Yoksay (Skip for Re-Parse) | Bu alan işaretlendiğinde, API Proxy "re-parse" işlemine tabi tutulduğunda bu uç noktanın güncellenmemesi gerektiğini belirtir. Örneğin tanım dosyasından bu uç nokta silinmiş ise dahi re-parse işlemi sonrası silinmeden kalır. |
Aktifleştirildiğinde, compressed yanıt için (Accept-Encoding başlık değerine göre) Base64 Encoded Text kullanılır, varsayılan değeri Byte Array'dir. (If enabled, Base64 Encoded Text is used For Compressed Response(by Accept-Encoding header value), default value is Byte Array) | Bu metoddan dönecek olan yanıt mesajının sıkıştırılmış olduğuna Accept-Encoding değeri içinde gzip, deflate veya br değerleri var mı diye bakılarak karar verilir. Eğer bu değerlerden birisi varsa yanıt mesajının durumu sıkıştırılmış (compressed)'tır. Dönen mesaj sıkıştırılmış durumda ise ve yanıt Byte Array tipinde ise ve;
|
HTTP Metot (HTTP Method) (From Client to API Proxy bölümünde) | Eklenecek olan metot/endpoint'e hangi HTTP metot ile istek gönderileceğidir. Girilmesi zorunludur. |
Adres (Path) (From Client to API Proxy bölümünde) | Eklenecek olan metot/endpoint'e hangi adresten erişileceğidir. Bu adres, API'nin kök adresine göreli olarak yazılır. Girilmesi zorunludur. |
Açıklama (Description) (From Client to API Proxy bölümünde) | Eklenecek olan metot/endpoint'e ilişkin açıklama bilgisidir. Girilmesi isteğe bağlıdır. |
Backend HTTP Metot (Backend HTTP Method) (From API Proxy to Backend API bölümünde) | Bu metoda gelen isteğin Backend API'ye hangi HTTP metot ile gönderileceğidir. |
Önbellek Ayarları (Cache Settings) | Bu ayar aktifleştirilirse metot/endpoint bazlı önbellek ayarları aktifleştirilmiş olur. |
Önbellek Anahtar Tipi (Cache Key Type) | Önbellek Anahtar Tipi için iki seçenek vardır:
Örneğin sorgu parametresi /metodAdı?param1=value1¶m2=value2 şeklinde olduğunda önbellekte tutulacak anahtar "param1=value1¶m2=value2" değerinden oluşur, ve bir daha istek bu şekilde geldiğinde önbellekteki sonuç döner.
Bu değer seçildiğinde "Değişken Listesi" tablosunda belirtilecek alanlar ile anahtar oluşturulur. |
Değişken Listesi (Variable List) | Önbellek Key Tipi olarak "Özel Anahtar Oluştur (Create Custom Key) "seçilirse bu alan aktifleşir. Bu seçenek ile oluşturulacak olan önbellek anahtarının istek mesajının başlık, parametre veya gövde bölümlerinden belirtilecek alanların kombinasyonu ile yapılması sağlanır. Örneğin; "İstek mesajının başlığındaki APIKEY değeri ve gövdesindeki "//identity_no" XPath değerine göre anahtar oluştur" şeklinde ifade yazılabilir. |
Kapasite (Capacity) | Önbellekte saklanabilecek maksimum yanıt sayısıdır. |
Önbellek Geçersizleme İçin Yetki Gerekir (Invalidation Requires Authn) | Önbelleği geçersiz kılmak için yetkilendirme gerekiyorsa seçilir. |
Yetkisiz İsteklerin Ele Alınması (Handling Action) | Önbelleği geçersiz kılmak için yetkilendirme gerekiyorsa yetkisiz istekler için yapılacak işlem seçilir:
|
TTL (saniye) (TTL (seconds)) | Önbelleğe alınan yanıtın geçerli olacağı süre saniye olarak girilir. |
Null/Boş Değerleri Önbelleğe Al (Cache Null Value) | Boş değerlerin de önbelleğe alınması isteniyorsa işaretlenir. |
SOAP Metod Ayarları Güncelleme
REST tipindeki API Proxylerde sadece metod güncelleme işlemi yapılabilir.
SOAP tipindeki API Proxy'nin metotları için yapılabilecek ayarlar REST tipindeki ayarlardan farklı olu pbu ayarları içeren görsele aşağıda yer verilmiştir:
SOAP tipindeki API Proxy'nin metot ayarları için kullanılan alanlar aşağıdaki tabloda görülmektedir.
| Alan | Açıklama |
|---|---|
SOAP Action (SOAP Action) | WSDL dosyası ayrıştırıldığında metod için belirtilmiş olan SOAPAction değeri otomatik elde edilir. Fakat herhangi bir sebepten dolayı farklı bir değer kullanmak için bu alandaki değer değiştirilebilir. |
İndirmeyi Etkinleştir (Enable Download) | API Metodundan/Endpointinden dönen sonuç Byte Array tipinde ise sonucun dosya olarak ele alınması için bu seçenek işaretlenir. Aksi halde içerik encoded text olarak istemciye döner. Sonucun Byte Array olup olmadığına karar vermek için ise Content Type Header değerinin sistem ayarlarındaki "Byte Array Tipleri" listesinde yer alıp almadığına bakılır. Eğer bu listede yer alıyorsa sonucun Byte Array tipinde olduğuna karar verilir. |
Aktifleştirildiğinde, compressed yanıt için (Accept-Encoding başlık değerine göre) Base64 Encoded Text kullanılır, varsayılan değeri Byte Array'dir. (If enabled, Base64 Encoded Text is used For Compressed Response(by Accept-Encoding header value), default value is Byte Array) | Bu metoddan dönecek olan yanıt mesajının sıkıştırılmış olduğuna Accept-Encoding değeri içinde gzip, deflate veya br değerleri var mı diye bakılarak karar verilir. Eğer bu değerlerden birisi varsa yanıt mesajının durumu sıkıştırılmış (compressed)'tır. Dönen mesaj sıkıştırılmış durumda ise ve yanıt Byte Array tipinde ise ve;
|
Re-Parse'da Yoksay (Skip for Re-Parse) | Bu alan işaretlendiğinde, API Proxy "re-parse" işlemine tabi tutulduğunda bu metodun güncellenmemesi gerektiğini belirtir. Örneğin tanım dosyasından bu method silinmiş ise dahi re-parse işlemi sonrası silinmeden kalır. |
WSA Ayarı (WSA Settings) | Bu kısım sayesinde WS-Security Addressing ayarları her metod için ayrı ayrı aktifleştirilebilir. Aktif hale getirildiğinde ilgili WSA değerleri SOAP mesajına eklenir. |
Anlaşılmalı (Must Understand) | "Must Understand" değerinin ayarı yapılır. |
Versiyon (Version) | Kullanılacak olan WSA versiyonu seçimi yapılır. |
Ön Tanımlı Aksiyonu Ekle (Add Default Action) | SOAP mesajına WSDL dosyası ayrıştırılırken belirlenmiş ön tanımlı aksiyonun eklenmesini sağlar. Aktif hale getirildiğinde aşağıdaki aksiyon ifadesi kaybolur. |
Aksiyon (Action) | SOAP mesajına özelleştirilmiş aksiyon eklenmesi için bu alan kullanılır. |
Ön Tanımlı Kime Bilgisi Ekle (Add Default To) | SOAP mesajına WSDL dosyası ayrıştırılırken belirlenmiş ön tanımlı kime bilgisinin eklenmesini sağlar. Aktif hale getirildiğinde aşağıdaki kime ifadesi kaybolur. |
Kime (To) | SOAP mesajına özelleştirilmiş kime bilgisi eklenmesi için bu alan kullanılır. |
Yanıt Kime (Reply To) | SOAP mesajına özelleştirilmiş yanıt kime bilgisi eklenmesi için bu alan kullanılır. |
Mesaj ID Üret (Generate Message ID) | SOAP mesajına her mesaj için farklı üretilmiş Mesaj ID eklenmesi için bu alan aktif hale getirilir. |
Mesaj ID (Message ID) | SOAP mesajına her mesaj için sabit bir Mesaj ID eklenmesi için bu alan aktif hale getirilir. |
Kimden (From) | SOAP mesajına özelleştirilmiş kimden bilgisi eklenmesi için bu alan kullanılır. |
Hata Kime (Fault To) | SOAP mesajına özelleştirilmiş hata kime bilgisi eklenmesi için bu alan kullanılır. |
Hata İlişkisi (Relates To) | SOAP mesajına özelleştirilmiş hata ilişkisi bilgisi eklenmesi için bu alan kullanılır. |
Hata İlişki Tipi (RelationShip Type) | SOAP mesajına özelleştirilmiş hata ilişki tipi bilgisi eklenmesi için bu alan kullanılır. |
Önbellek Ayarları (Cache Settings) | Bu ayar aktifleştirilirse metot/endpoint bazlı önbellek ayarları aktifleştirilmiş olur. |
Önbellek Key Tipi (Cache Key Type) | Önbellek Anahtar Tipi için iki seçenek vardır:
Örneğin sorgu parametresi /metodAdı?param1=value1¶m2=value2 şeklinde olduğunda önbellekte tutulacak anahtar "param1=value1¶m2=value2" değerinden oluşur, ve bir daha istek bu şekilde geldiğinde önbellekteki sonuç döner.
Bu değer seçildiğinde "Değişken Listesi" tablosunda belirtilecek alanlar ile anahtar oluşturulur. |
Değişken Listesi (Variable List) | Önbellek Key Tipi olarak "Özel Anahtar Oluştur (Create Custom Key) "seçilirse bu alan aktifleşir. Bu seçenek ile oluşturulacak olan önbellek anahtarının istek mesajının başlık, parametre veya gövde bölümlerinden belirtilecek alanların kombinasyonu ile yapılması sağlanır. Örneğin; "İstek mesajının başlığındaki APIKEY değeri ve gövdesindeki "//identity_no" XPath değerine göre anahtar oluştur" şeklinde ifade yazılabilir. |
Kapasite (Capacity) | Önbellekte saklanabilecek maksimum yanıt sayısıdır. |
Önbellek Geçersizleme İçin Yetki Gerekir (Invalidation Requires Authn) | Önbelleği geçersiz kılmak için yetkilendirme gerekiyorsa seçilir. |
Yetkisiz İsteklerin Ele Alınması (Handling Action) | Önbelleği geçersiz kılmak için yetkilendirme gerekiyorsa yetkisiz istekler için yapılacak işlem seçilir:
|
TTL (saniye) (TTL (seconds)) | Önbelleğe alınan yanıtın geçerli olacağı süre saniye olarak girilir. |
Null/Boş Değerleri Önbelleğe Al (Cache Null Value) | Boş değerlerin de önbelleğe alınması isteniyorsa işaretlenir. |
Metot/Endpoint Silme
Uç Noktayı Sil (Delete Endpoint) bağlantısına tıklanır. Onay işleminden sonra metot/endpoint silinir.
Metot/Endpoint Geçici Olarak Kullanımdan Kaldırma
Bir metot/endpoint'in silinmeden erişime kapatılması mümkündür. Bunun için Uç Noktayı Devre Dışı Bırak (Disable Endpoint) bağlantısına tıklanır. Bağlantıya tıklandığında metot/endpoint kullanımdan kaldırılmış olur ve bununla birlikte arayüzde aşağıdaki değişiklikler gerçekleşir.
- Metot/endpoint'in yanındaki simge, metot/endpoint'in kullanım dışı olduğunu gösterecek şekilde değişir.
- Uç Noktayı Devre Dışı Bırak (Disable Endpoint) bağlantısı kaybolur. Bunun yerine Uç Noktayı Etkinleştir (Enable Endpoint) bağlantısı gelir.
Metot/Endpoint Test Etme
Eğer bir API Proxy en az bir ortama yüklenmişse, metot/endpoint'leri bu sekmeden kolayca test edilebilir. Bunun için seçilen metot/endpoint için Uç Noktayı Test Et (Test Endpoint) bağlantısına tıklandığında bu metot/endpoint için Test Konsolu açılır. Test etme hakkında detaylı bilgi için Test Konsolu (Test Console) arayüzüne bakabilirsiniz.