API Proxy Grubu Listesi
API Proxy Grubu listesi ilk açıldığında aşağıdaki görselde olduğu gibi mevcut API Proxy Grupları listelenir.
API Proxy Grubu Oluşturma
Yeni API Proxy Grup oluşturmak için API Proxy Grubu Listesi arayüzünde sağ üst köşedeki (plus) Yeni (Create) tuşuna tıklanır. API Proxy Grubu oluşturma ekranı:
| Alan | Açıklama |
|---|---|
| Name | API Proxy Group için benzersiz bir isim. Boşluk ve özel karakterler kullanılmamalı, grup tanımlaması için anlamlı bir isimlendirme yapılmalıdır. |
| Description | API Proxy Group’un amacını ve kullanım senaryosunu açıklayan isteğe bağlı metin alanı. Yönetim ve bakım süreçlerinde grubun işlevini anlamak için kullanılır. |
| Client Route | İstemcilerin bu API Proxy Group’a erişmek için kullanacakları yönlendirme bilgisi. Path, method veya header bazlı yönlendirme seçeneklerinden en az biri seçilmelidir.**Relative Paths:**API Proxy Group’a yönlendirilecek göreli URL path’leri. Birden fazla path tanımlanabilir, her path ”/” ile başlamalıdır.**Methods:**Bu grup için izin verilen HTTP metodları (GET, POST, PUT, DELETE, PATCH, OPTIONS, HEAD). Varsayılan olarak tüm metodlar seçilebilir.**Hosts:**Backend servislerinin host adresleri. Birden fazla host eklenebilir.**Headers:**API Proxy Group seviyesinde eklenecek veya değiştirilecek HTTP header’ları. Key-value çiftleri olarak tanımlanır, tüm bu gruba ait isteklere uygulanır.Detaylı bilgi için bakınız: Client Route Ayarları |
API Proxy Grubunu Biçimlendirme
Genel Bakış (Overview), Ayarlar (Settings) ve Geliştirme (Development) sekmelerinin biçimlendirmesi API Proxy’ninkilerle birkaç küçük farklılık dışında tamamen aynıdır.Genel Bakış Sekmesi (Overview Tab)
Genel Bakış Sekmesi’ni içeren görsele aşağıda yer verilmiştir:
| Alan | Açıklama |
|---|---|
| Ad(Name) | API Proxy Grubunun adıdır. Zorunlu alandır. |
| Açıklama(Description) | API Proxy Grubuna ilişkin açıklama/tanım bilgisidir. Girilmesi isteğe bağlıdır. |
| Client Route | İstemcilerin API Proxy Group’a erişim için kullanacağı yönlendirme bilgileri. Detaylı bilgi için bakınız: Client Route Ayarları |
| Proxy Grubu Anahtarı(API Proxy Group Key) | API Proxy Grup üzerinden JWT veya OAuth2 yetkilendirmesi yapılmak istendiğinde ihtiyaç duyulan Genel ve Gizli Anahtarların yönetildiği bölümdür. Detaylı bilgi için bu anahtarların API Proxy için nasıl yönetildiğine bakınız. |
| Deployment Information | API Proxy Group’un deployment durumu ve ortam bilgileri. **Environment:**API Proxy Group’un deploy edildiği ortam (Development, Test, Production). **URL:**API Proxy Group’a erişim için kullanılacak tam URL adresi. **Specs:**API Proxy Group’un OpenAPI/Swagger spesifikasyon bilgileri. |
API Proxy Grup Anahtarı (API Proxy Group Key) Bölümü
API Proxy Grubun 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 Grup için anahtarlardan herhangi birisi yeniden oluşturulursa, anahtarların geçerli olabilmesi için API Proxy Grubun yeniden yüklenmesi gerekir.
API Proxy Grubu Swagger Arayüzünde Görüntüleme
API Proxy Group deploy edildikten sonra Deployment bölümünde ilgili erişim adresine ait Göster _(Show)_butonu gelir. Bu butona tıklandığında API Proxy Grubun JSON formatındaki Open API specification bilgisine ulaşılır.
API Tanım Dosyalarına Erişim
Tanım dosyalarının içeriği, 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 Grup’un yüklenmiş olduğu Ortamdaki erişim adresini aşağıdaki şekilde kullanabilirler: Örneğin API Proxy’nin Production Ortamındaki erişim adresihttps://api.apinizer.com/apigateway/apiProxyGroup olsun.
Tanım dosyalarına erişim için aşağıdaki adreslere istek gönderilebilir;
Swagger 2.x (JSON)
https://api.apinizer.com/apigateway/apiProxyGroup?swaggerhttps://api.apinizer.com/apigateway/apiProxyGroup?swagger&format=jsonhttps://api.apinizer.com/apigateway/apiProxyGroup?swagger.json
https://api.apinizer.com/apigateway/apiProxyGroup?swagger&format=yamlhttps://api.apinizer.com/apigateway/apiProxyGroup?swagger.yaml
https://api.apinizer.com/apigateway/apiProxyGroup?openapihttps://api.apinizer.com/apigateway/apiProxyGroup?openapi&format=jsonhttps://api.apinizer.com/apigateway/apiProxyGroup?openapi.json
https://api.apinizer.com/apigateway/apiProxyGroup?openapi&format=yamlhttps://api.apinizer.com/apigateway/apiProxyGroup?openapi.yaml
Ayarlar Sekmesi (Settings Tab)
Ayarlar sekmesi üzerinden API Proxy Grubu için aşağıdaki ayarlamalar yönetilebilir. Bu ayarların detayı için Ayarlar Sekmesi _(Settings Tab)_sayfasına bakınız.- CORS
- Cache
- XML Hata Yanıt Şablonunu Özelleştirme
- JSON Hata Yanıt Şablonunu Özelleştirme
- İletilen IP Başlık Parametreleri
- Ignore Error Response Template: Error response template’in ignore edilmesi ayarı, API Proxy Group bazında ayarlanabilmektedir.
- API Proxy Trafiği Log Ayarları
Geliştirme Sekmesi (Development Tab)
Geliştirme sekmesinde API Proxy Grubunun politikaları yönetilir. Detaylı bilgi için API Proxy için politikaların nasıl yönetildiğinin anlatıldığı Geliştirme Sekmesi (Development Tab) sayfasına bakınız. Geliştirme Sekmesi’ni içeren görsele aşağıda yer verilmiştir:
API Proxy’ler Sekmesi (API Proxies Tab)
API Proxy Grup içerisinde yer alan API Proxy’ler ve Deployment bilgileri bu bölümden yönetilir. API Proxy Grup deploy edilmemiş ise, URL kısmı boş gözükür. API Proxy’ler Sekmesi’ni içeren görsele aşağıda yer verilmiştir:
Endpoints Sekmesi
Endpoints Sekmesi’ni içeren görsele aşağıda yer verilmiştir:
Endpoint Test Etme
Endpoint’i test etmek için test butonuna tıklanır.
Endpoint Detayını Görüntüleme
Endpoint detayını görüntülemek için satır sonunda yer alan butona tıklanır.
- Ortam’ın erişim adresi:
https://demo.apinizer.com/apigateway - API Proxy Grubu için verilen Geçit Adresi:
/apiProxyGroup1 - API Proxy Grubunun yüklendiği ortamdaki adresi:
https://demo.apinizer.com/apigateway/apiProxyGroup1 - API Proxy için verilen Geçit Adresi:
/petstore - API Proxy’nin yüklendiği ortamdaki adresi:
https://demo.apinizer.com/apigateway/petstore - Erişilmek istenen endpoint:
/pet/findByStatus - Erişilmek istenen endpoint’in HTTP metot değeri: GET
API Proxy’e Doğrudan Erişim
API Proxy Grubuna eklenmiş API Proxy’lere doğrudan erişimde herhangi bir değişiklik olmaz. İstemciler, yüklendikleri Ortamlara göre oluşturulan adresleri aracılığıyla API Proxy’lere erişmeye devam eder. GET isteğinin gönderileceği adres:API Proxy Gruba Erişim
API Proxy’lerin metot/endpoint’lerine API Proxy Grubunun adresi üzerinden erişilebilir.REST tipindeki API Proxy’nin bir endpoint’e erişim
Kullanılacak erişim adresi, API Proxy Grubu için belirtilen geçit adresine, erişilecek metot/endpoint’in adresi eklenerek bulunur. Bu işlem sırasında API Proxy’nin kendi adresi dikkate alınmaz. GET isteğinin gönderileceği adres:
SOAP tipindeki API Proxy’nin bir metot/endpoint’ine erişim
API Proxy Grubunun erişim adresine, çağrılmak istenen metodun SOAPAction header’ı ve ilgili SOAP mesajı ile istek göndermek yeterlidir.İlgili Sayfalar
API Proxy Group
API Proxy Group kavramını öğrenin
Client Route Ayarları
Client Route yapılandırması
API Proxy Oluşturma
API Proxy oluşturma
Politika Yönetimi
Politika yönetimi hakkında bilgi edinin
Global Politikalar
Global politikalar hakkında bilgi edinin
Politika Grupları
Politika grupları hakkında bilgi edinin