REST API Çağrısı Poliçesi


REST API Çağrısı Poliçesi, Apinizer ile client veya Apinizer ile server arasında olan bütün iletişimler sırasında 2. bir REST API’yi çağırmaya yarar. Apinizer’ın her adımında kullanıbilen bu poliçesi ile ikinci bir API çağrılarak loglama, doğrulama gibi işlemler gerçekleştirilip iş yükü dağıtılabilir, yada 2. API’den gelen bilgilere göre devam edilecek yol seçilebilir.


A. Fake API Tanımı

                REST API Çağrısı özelliğinin kullanımını göstermek için Apinizer üzerinden basit bir sahte API tanımlayacağız. Eğer çağırmak istediğiniz 2. API hazırsa bu başlığı geçebilirsiniz.

  1. Fake API için API Listesinden yeni bir API oluşturmak gerek.


  2. API’ı kendimiz yaratacağımız için tanım dosyası olmadan API yarat seçeneği ile devam ediyoruz.


  3. Aşağıda sıralamayı takip edip Apinizer üzerinden sahte API oluşturarak, kullanıcı objesi döndürmesi için bir metod ekleyeceğiz.


  4. Uç nokta oluştur dedikten sonra açılan diyaloğu bu şekilde dolduruyoruz, sonra oku takip edip kullanıcı modelini oluşturmaya gidiyoruz.


  5. Çok basit bir kullanıcı modeli ekleyip kaydete basıyoruz.

  6. Uç nokta menüsünde de kaydete bastıktan sonra solt attaki yeşil geçit oluştur tuşuna basarak Fake API geçidini oluşturma sayfasına gidiyoruz.


  7. Fake API için bir geçit adresi seçip kayıt ettikten sonra geçidi aktifleştiriyoruz.


Fake API ile işimiz şimdilik bu kadar. Normal API’lerde yapmaya alışık olduğumuz gibi Geçidi biçimlendirmeye gerek yok, REST API Çağrısı poliçesini asıl API’mizin geçit arayüzünden ekleyeceğiz.

REST API Çağrısı poliçesini kullanmak için,  Poliçemizi atamak istediğimiz API’nin poliçeler penceresinden istediğimiz bölge için poliçe oluşturma menüsüne gidip, "REST API Çağrısı" nı seçiyoruz.


B. Tek Yönlü (Yanıtı Dikkate Alma) ile REST API Çağrısı

  1. Tek yönlü çağrıda adından da anlaşıldığı gibi Apinizer 2. API’yi, çağırıp işleme devam eder, gelen API’den dönen veriyi beklemez.


  2. Tek yönlü (ve çift yönlü) çağrıda, öncelikle çağıracağımız API’nin adresini ve metodunu seçerek kuruluma başlıyoruz.

  3. “REST API'ye gönderilecek mesajı hazırlama” bölümünü genişleterek asıl konfigürasyona başlayabiliriz. REST API’a gönderilecek isteğin her bölümünü ayrı ayrı kontrol etmemizi sağlayan bölümler var:

    Gönderilecek Mesaj Gövdesi

    Burada yollayacağımız mesaja bir JSON gövdesi eklenebilir.

    Başlıklar

    Bu kısımda mesajda var olan HTTP başlıklarından seçerek istediklerimizi kaldırabiliyor, ya da fazladan başlık ekleyebiliyoruz.

    Parametreler

    Burada da tıpkı başlıklardaki gibi seçtiğimiz parametrelerden kurtulabiliyor veya kendi parametrelerimizi ekleyebiliyoruz.


    ●Gönderilecek Mesaj Gövdesi: REST API'ye gönderilmek üzere mesaj gövdesinin tamamını ya da bir kısmını belirleyebilirsiniz. Eğer yukarıdaki “Orijinal Mesajdan Gelen Gövdeyi Sil” kutusunu işaretlerseniz, buraya yazdığınız içerik mesaj gövdesi olarak kullanılır. Eğer kutuyu işaretlemezseniz, buraya yazdığınız içeriğin orijinal mesajdan gelen gövdenin neresine yerleştirileceğini belirleyebilirsiniz.

    Başlıklar: Bu kısımda mesajda var olan HTTP başlıklarından seçerek istediklerimizi kaldırabiliyor, ya da fazladan başlık ekleyebiliyoruz.

    Parametreler: Burada da tıpkı başlıklardaki gibi seçtiğimiz parametrelerden kurtulabiliyor veya kendi parametrelerimizi ekleyebiliyoruz.

    Ayrıca her başlığın “Orijinal Mesajdan Gelen ABCleri Sil” isminde kutucuklarını görüyorsunuz.    İsminden anlaşıldığı gibi bu kutucukları tiklerseniz, Orijinal mesajdaki bütün veri silinip yerine sadece bizim girdiğimiz yeni veriler 2. API’ye gider.


  4. Fake API’ye giden bütün istekleri Apinizer’ın loglama menüsünden takip edip poliçenin beklediğimiz gibi çalışıp çalışmadığını da doğrulayabiliriz.


C. Çift Yönlü (Yanıtı İşleme Sok) ile REST API Çağrısı

  1. Çift yönlü çağrı tek yönlünün tüm özelliklerine sahip olup, onun üstüne gelen mesajla dilediğimizi yapmamıza olanak sağlıyor. 2. API’den gelen mesajın parçalarını, orijinal mesajla beraber asıl API’ye iletebiliyor, bunu tek yönlüdeki gelen mesaj arayüzüne çok benzer bir arayüzle ayarlayabiliyoruz.

  2. “HTTP Metodu” ve “REST API'ye gönderilecek mesajı hazırlama” kısımlarını, tek yönlü API ile aynı şekilde yapılandırabiliyoruz. Bunlarda rehberlik için bir önceki bölüme bakabilirsiniz.


  3. Tıpkı gönderilecek mesajı ayarladığımız gibi, burada da aynı 3 bölüm mevcut:

    Mesaj Gövdesi

    Burada yollayacağımız mesaja bir JSON gövdesi eklenebilir.

    Başlıklar

    Bu kısımda mesajda var olan HTTP başlıklarından seçerek istediklerimizi kaldırabiliyor, ya da fazladan başlık ekleyebiliyoruz.

    Parametreler

    Burada da tıpkı başlıklardaki gibi seçtiğimiz parametrelerden kurtulabiliyor veya kendi parametrelerimizi ekleyebiliyoruz.


    Mesaj Gövdesi: Burada mesaj gövdesinin kaynağı olarak “Değişken kullan” ve “Değer gir” seçenekleriyle karşılasıyoruz. Değişken kullan’da, yeni mesaj gövdesini 2. API’dan gelen gövdenin içindeki bir değişkenden seçerken, Değer gir seçeneğinden elle bir JSON oluşturup onu yollayabiliyoruz.


    ●Başlıklar: Bu kısımda mesajda var olan HTTP başlıklarından seçerek istediklerimizi kaldırabiliyor, ya da fazladan başlık ekleyebiliyoruz.


    ●Parametreler: Burada da tıpkı başlıklardaki gibi seçtiğimiz parametrelerden kurtulabiliyor veya kendi parametrelerimizi ekleyebiliyoruz.