Bu sekmede, seçilen API Proxy ile ilgili genel ayarlar bulunur. 

Genel Bilgi sekmesini içeren görsele aşağıda yer verilmiştir:


Eğer ilgili API Proxy bir Gruba dahilse, API Proxy Grup Etkin (API Proxy Group Enabled) linkine tıklayarak API Proxy'nin ait olduğu Grup ekranına gidilebilir.


Yapılandır (Configure) butonuna tıklayarak açılan dialogu içeren görsele aşağıda yer verilmiştir:


Yapılandırma için kullanılan alanlar aşağıdaki tabloda görülmektedir.

Alan

Açıklama

Adı

(Name)

API Proxy'ye kullanıcı tarafından verilen addır. Proje genelinde Tekil olmalıdır.

Açıklama

(Description)

API Proxy'nin tanım bilgisidir. 

Geçit Adresi

(Relative Path)

Geçit Adresi bu API Proxy'nin erişime açılan adresinin (URL) bir parçasıdır.

Gelen isteklerin uygun API Proxy'e yönlendirilmesi için API Proxy'nin adresi kullanılır. Bunun için aşağıdaki örnekte olduğu gibi, yüklenen (deployed) her API Proxy için Geçit Adresi de kullanılarak biricik bir adres oluşturulur:

Apinizer'in çalıştığı sunucunun erişim adresi: https://demo.apinizer.com olsun.

Geçit Adresi: /petstoreProxy olsun.

API Proxy'nin yüklendiği Ortamın erişim adresi: /apigateway olsun. 

Erişilmek istenen endpoint URL: /findByStatus olsun.

Bu durumda bu API Proxy'nin bu Ortam üzerinde, bu endpoint için erişim adresi:

https://demo.apinizer.com/apigateway/petstoreProxy/findByStatus olacaktır.

Bu değer Proje genelinde Tekil olmalıdır.

Eğer Proje ayarları yapılırken, Proje için Enable Relative Path değeri aktif edilirse, bu projede oluşturulacak tüm API Proxy'lerin Geçit Adresi değerlerinin önüne Proje için tanımlanan Geçit Adresi salt okunur olarak eklenecektir.

Bu seçenek aktifleştirildiğinde, ilgili servise sadece bir proxy grubunun adresinden erişilebilir.

Backend API Versiyon

(Backend API Version)

API Proxy'e tanımlanan Backend API Versiyonunun girildiği alandır.

Kategori Listesi

(Category List)

API Proxy'lerin yönetiminde kolaylık sağlamak üzere kategoriler oluşturulabilir. Kategori listesi, API Proxy'nin hangi kategorilere ait olduğunu belirlemek için kullanılır.

Kullanım Şekli

(Usage)

API Proxy'nin Üretici, Tüketici veya Üretici ve Tüketici olarak kullanım şeklinin belirtildiği bölümdür.


Proxy Anahtarını Göster (Show Proxy Key)

API Proxy'nin erişim anahtarlarının yönetildiği bölümdür. Erişim anahtarları OAuth2 Kimlik Doğrulama Politikası için kullanılır. 

Client Id ve Client Secret değerleri otomatik olarak oluşturulur ve kullanıcı yenilerinin oluşturulmasını isteyebilir. Yüklenmiş bir API Proxy için anahtarlardan herhangi birisi yeniden oluşturulursa, anahtarların geçerli olabilmesi için API Proxy'nin yeniden yüklenmesi gerekir.

Proxy Anahtarını Göster bölümünü içeren görsele aşağıda yer verilmiştir:



Proxy Anahtarını Göster butonuna tıklandığında açılan dialogu içeren görsele aşağıda yer verilmiştir:


Yükleme ve Tanım Dosyası Bilgileri (Deployment and Specification Information)

Yükleme bilgileri bölümü, API Proxy'in hangi ortamlara yüklendiğinin ve bu ortamdaki erişim adresinin görüntülendiği bölümdür. Bir API Proxy, aynı anda birden fazla ortama yüklenebilir.

Eğer API Proxy'den bir API Proxy Group oluşturulmuşsa o gruba ait bilgiler de bu alanda görüntülenir.

Yükleme bölümünü içeren görsele aşağıda yer verilmiştir:


Yükleme bölümü konfigürasyonu için kullanılan alanlar aşağıdaki tabloda görülmektedir.

Alan

Açıklama

Ortam

(Environment)

API Proxy'nin yüklenmiş olduğu Ortam bilgisidir.

Erişim Tipi

(Access Type)

API Proxy'nin erişim tipinin bilgisidir.

URL

API Proxy'nin erişim adresidir. Geçit Adresi ve yüklenen Ortamın erişim adresi kullanılarak otomatik olarak üretilir.

Tanım Dosyaları

(Specs)

API Proxy'nin Tanım dosyalarıdır. Her API Proxy için Swagger ve OpenAPI formatlarında tanım dosyaları üretilir. Eğer API Proxy'nin tipi SOAP ise WSDL ve XSD tanım dosyaları da üretilecektir. Herhangi bir ortam için Göster (Show)  bağlantısına tıklandığında, API Proxy'nin o ortam için geçerli olan API Tanım Dosyaları görüntülenir.


Göster (Show) butonuna tıklandığında farklı tip ve formattaki API Proxy tanımlarını gösteren dialoga aşağıda yer verilmiştir:


Eğer ilgili API Proxy bir Gruba dahilse ve API Proxy Grup ekranından API Proxy'lere Direkt Erişimi Engelle seçeneği seçilmiş ise, bu bölümde bir uyarı kutucuğu gelir.

Tanım Dosyalarına API Proxy Üzerinden Erişim

Tanım dosyalarının içeriği, Göster (Show) bağlantısına tıklandığında yukarıdaki şekilde görüldüğü gibi açılır ve buradan kopyalanabilir. Ancak bu yöntem Apinizer platformu üzerinde çalışmakta olan API Geliştirici, API Testçi gibi rollerden kullanıcılar içindir. İstemciler bu arayüzlere erişemez.

İstemciler, tanım dosyalarına erişmek için API Proxy'nin yüklenmiş olduğu Ortamdaki erişim adresini aşağıdaki şekilde kullanabilirler:

Örneğin API Proxy'nin Production Ortamındaki erişim adresi https://demo.apinizer.com/apigateway/petstoreProxy olsun.

Tanım dosyalarına erişim için aşağıdaki adreslere istek gönderilebilir;

Swagger 2.x (JSON)

  • https://demo.apinizer.com/apigateway/petstoreProxy?swagger
  • https://demo.apinizer.com/apigateway/petstoreProxy?swagger&format=json
  • https://demo.apinizer.com/apigateway/petstoreProxy?swagger.json

Swagger 2.x (YAML)

  • https://demo.apinizer.com/apigateway/petstoreProxy?swagger&format=yaml
  • https://demo.apinizer.com/apigateway/petstoreProxy?swagger.yaml

OpenAPI 3.x (JSON)

  • https://demo.apinizer.com/apigateway/petstoreProxy?openapi
  • https://demo.apinizer.com/apigateway/petstoreProxy?openapi&format=json
  • https://demo.apinizer.com/apigateway/petstoreProxy?openapi.json

OpenAPI 3.x (YAML)

  • https://demo.apinizer.com/apigateway/petstoreProxy?openapi&format=yaml
  • https://demo.apinizer.com/apigateway/petstoreProxy?openapi.yaml

WSDL (API Proxy SOAP ise)

  • https://demo.apinizer.com/apigateway/calc?wsdl