Ana içeriğe atla

Documentation Index

Fetch the complete documentation index at: https://docs.apinizer.com/llms.txt

Use this file to discover all available pages before exploring further.

Aşağıdaki grafikte yer alan numaralandırmalar işlemlerin yapılış sırasına aittir.
  • Apinizer içerisinde yer alan Security Manager, API Client’tan Basic (Base64) türünde authentication bilgisini ister. Bu authentication doğru ise akış devam eder.
  • Apinizer, Backend API’ye istekte bulunur.
  • Backend API, Apinizer’a yanıt verir.
  • Apinizer, API Client’a yanıt verir.
Senaryo Diyagramı

​
API Proxy’nin Oluşturulması

Senaryo Diyagramı Swagger Petstore isimli REST API’ye https://petstore.swagger.io/ adresinden erişim sağlanabilmektedir. Development menüsü altında yer alan API Proxies seçeneğine tıklanır.
Açılan sayfada daha önceden herhangi bir proxy tanımı yapılmadığı için No records found! yazısı yer alır.
Sağ üst köşede yer almakta olan Create butonuna tıklanır ve yeni bir proxy oluşturulmaya başlanır. Senaryo Diyagramı Bu kısımda oluşturulacak olan API Proxy’nin hangi tipte olduğunun seçilmesi gerekmektedir. Bu senaryoda kullanılacak olan API’nin türü Swagger 2.X olacağı için bu tür seçilir. Enter URL ifadesine tıklanarak kullanılacak olan API’nin adresinin girileceği ekrana geçiş yapılır. Senaryo Diyagramı URL kısmına erişim sağlanacak adres girilerek Parse butonuna tıklanır. Senaryo Diyagramı Parse işlemi yapıldıktan sonra API Proxy’ye ait ayarlar yapılabilmektedir.
  • Usage alanı ile oluşturulan API Proxy’nin kim tarafından kullanılacağı belirtilir. Burada publisher, consumer, publisher and consumer gibi seçenekler yer almaktadır.
  • Sharing Type alanı ile oluşturulan API Proxy’nin paylaşım tipi belirtilir. Burada external, internal, external and internal gibi seçenekler yer almaktadır.
  • Addresses sekmesi altında yer alan iki API adresinden biri veya her ikisi de seçilebilir eğer iki adres de seçilecek olursa Apinizer Load Balance işlemini kendisi gerçekleştirecektir.
  • Relative Path ise oluşturulan API Proxy’nin erişime açılacak adresidir.
  • Category List alanı da oluşturulan API Proxy’nin kategorilendirilmesine olanak sağlar.
Senaryo Diyagramı Bu ayarlamalar yapıldıktan sonra API Proxy kaydedilir. Kaydetme işleminden sonra açılan sayfada Develop sekmesine tıklanır. Senaryo Diyagramı
Bu endpointlerin üstünde yer alan All ifadesiyle eklenecek olan poliçeler tüm endpointlere uygulanabilmektedir.
Oluşturulan API Proxy deploy edilir. Bunun için yukarıda orta kısımda yer alan Deploy butonuna tıklanır. Senaryo Diyagramı

​
Credentials Oluşturulması

Eklenecek Credential’a ait bilgiler username = apinizer, password = 123123aA olacak şekildedir. Identity Management menüsüne gelinir. Burada ise Credential Management menüsü altında yer alan Credentials menüsüne tıklanır. Senaryo Diyagramı Açılan ekranda sağ üst köşede yer alan Create butonuna tıklanır. Senaryo Diyagramı Burada gerekli olan alanlar daha önceden belirtilen bilgilerle doldurulur ve Save and Deploy butonuna tıklayarak oluşturulan credential kaydedilir. Senaryo Diyagramı Bu credential öğesinin erişim sağlayacağı proxy’nin seçilmesi gerekmektedir. Oluşturulan credential’ın üzerine gelip yanda yer alan menüden Edit seçeneğine tıklanır. Senaryo Diyagramı Açılan ekran üzerinden API Proxy ACL sekmesine tıklanır, bu sekme içerisinde yer alan butona tıklanır. Senaryo Diyagramı Açılan sayfada şu an üzerinde çalışılan projede bulunan API Proxy’ler listelenmektedir. Swagger Petstore isimli proxy seçilir. Add butonuna tıklayarak oluşturulan Credential öğesinin bu proxy’ye erişimi olacağı belirtilir. Senaryo Diyagramı Sağ üst köşede yer alan Save and Deploy butonuna tıklanır ve yapılan işlem kaydedilir. Senaryo Diyagramı

​
Değişken Tanımlaması

Poliçede kullanılacak olan değişkenin tanımının yapılması gerekmektedir. Add butonuna tıklanır. Senaryo Diyagramı
  • Name input alanına oluşturulmak istenilen değişkenin adı yazılır.
  • Type alanında ise kullanılacak değişkenin tipi belirtilir.
  • Header Name alanında ise kullanılacak değişkenin Header içerisinde hangi adla isimlendirileceği ifade edilir.
Yapılan değişiklikler Save butonuna tıklanarak kaydedilir. Senaryo Diyagramı

​
Authentication Poliçesinin Eklenmesi

Artık Basic (Base64) Authentication poliçesi eklenebilir duruma gelmiştir. API Proxy’lerin listelendiği sayfaya gidilir ve buradan Swagger Petstore isimli proxy seçilir. Daha sonra ise Develop sekmesine gelinir, Add Policy butonuna tıklanır. Açılan sayfada Basic Authentication poliçesi seçilir. Senaryo Diyagramı Bu ekran üzerinde yer alan alanlar:
  • Identity/Role/Group Service alanında seçilecek olan değer Security Manager değeridir. Çünkü credentials kontrolü Security Manager tarafından gerçekleştirilecektir.
  • Variable for authorization alanında ise kullanılan authentication türü Basic (Base64) olduğu için ve bu authentication türünde de kullanılan username-password bilgileri encrypted edildiği için bu ifade kullanılır. Bu senaryoda bu değer header içerisinden alınacaktır.
Clear Authentication Information seçeneği seçilirse gelen mesaj içerisinde authentication bilgisi silinir. Bu ayarın aktifleştirilmesi özel bir durum olmadığı sürece her zaman tavsiye edilmektedir.
  • Add Client Info To Header seçeneği backend API’ye gidecek Header içerisinde istemciye ait bilgilerin bulunup bulunmayacağını belirtir.
  • Bu seçenek aktif duruma gelirse Authenticated User Header Name isminde başka bir parametre ortaya çıkmaktadır.
  • Burada yer alan X-Authenticated-UserId ifadesi ise backend API’ye gidecek olan istemci bilgisinin hangi başlık ismi ile gideceğini belirtmektedir.
Senaryo Diyagramı
Poliçe kaydolduğu zaman ilgili ikon görülmektedir.
Yapılan işlemin geçerli olması için proxy’nin Deploy olması gerekmektedir. Senaryo Diyagramı

​
API Proxy’nin Test Edilmesi

“/pet/” endpoint’i seçildikten sonra, Test Endpoint butonuna tıklanır. Senaryo Diyagramı URL’de istenilen petId değeri “2” olarak girilir, Send butonuna basıldığında dönen yanıtın bir hata mesajı olduğu görülmektedir. Senaryo Diyagramı
Bu hatanın uygulanmış olan Basic (Base64) Authentication ile alakalı olduğu görülmektedir. Çünkü header’ın içerisine hiçbir şekilde bir authentication bilgisi yerleştirilmemiştir.
Bu proxy’de Basic (Base64) Authentication kullanıldığı için username ve password bilgilerinin de bu yönde encrypted edilmesi gereklidir.

​
Base64 Türünde Şifrelemenin Yapılması

Test menüsü altında yer alan Toolbox menüsü seçilir, burada Base64 şifreleme formatında encode ve decode yapabilecek bir araç bulunmaktadır. Bu araç seçilir. Senaryo Diyagramı decoded data alanına şifrelenmesini istediğiniz ifadeler yazılır, encoded data alanında ise şifrelenen veri elde edilir. Senaryo Diyagramı Encode edilmiş hali olan username ve password bilgisi buradan elde edilir ve tekrardan proxy’lerin listelendiği sayfaya gidilir. Swagger Petstore isimli proxy seçilir. Develop sekmesine geçiş yapılır burada listelenmekte olan endpoint’lerden “/pet/” endpoint’i seçilir ve Test Endpoint denir. URL’de istenilen petId değeri yine “2” olarak verilir. Headers içerisinde Authorization ifadesini ve buna da değer olarak encoded edilen username ve password bilgisi Base64 formatında girilir. Send butonuna tıklanarak belirtilen id’ye göre veri getirme işlemi gerçekleştirilir. Senaryo Diyagramı