Ana içeriğe atla
Client Route, API Proxy’lerinize gelen isteklerin nasıl yönlendirileceğini belirleyen yapılandırma ayarlarıdır. Client Route kavramı hakkında detaylı bilgi için Client Route sayfasına bakabilirsiniz.

Client Route Özellikleri

Genel Bakış: Image 2024 9 9 15 35 35 Pn Client Route özelliği ile aşağıdaki yönlendirme seçeneklerini kullanabilirsiniz:

Çoklu Path

Bir API Proxy’ye birden fazla relative path tanımlayabilirsiniz

Host Bazlı Yönlendirme

Host bilgisine göre farklı API Proxy’lere yönlendirme yapabilirsiniz

Header Bazlı Yönlendirme

HTTP header değerlerine göre yönlendirme kuralları oluşturabilirsiniz

Method Bazlı Yönlendirme

HTTP method bazlı yönlendirme yapabilirsiniz
Bu özellik geliştirilmeden önce, her API Proxy için yalnızca tek bir benzersiz (unique) relative path tanımlanabiliyordu. Yeni özellik ile aynı relative path’e sahip birden fazla API Proxy oluşturulabilir ve bunlar arasında host, header veya method bilgilerine göre dinamik yönlendirme yapılabilir.

Yönlendirme Öncelik Sırası

Gateway, gelen istekleri aşağıdaki öncelik sırasına göre değerlendirir:

1. Relative Path

En yüksek öncelik

2. Hosts

Host header kontrolü

3. Headers

Header kontrolü

4. Methods

En düşük öncelik

Eşleştirme Mantığı

Hosts (OR Mantığı)

Birden fazla host tanımlandığında OR mantığı ile çalışır. Yani tanımlanan hostlardan herhangi birinin eşleşmesi yeterlidir. Örnek:
Hosts: hostname_x.com, hostname_y.com
İstekteki Host header değeri hostname_x.com veya hostname_y.com ise koşul sağlanır.

Headers (AND Mantığı)

Birden fazla header tanımlandığında AND mantığı ile çalışır. Yani tanımlanan tüm header’ların eşleşmesi gerekir. Örnek:
Headers: testmode:true, test:true
İstekte hem testmode: true hem de test: true header’ları mevcut olmalıdır.

Path Eşleştirme

  • Relative path eşleştirmesi en yüksek önceliğe sahiptir
  • Daha spesifik (uzun) path’ler, daha genel (kısa) path’lerden önce değerlendirilir
  • Tam eşleşme bulunamazsa, en yakın parent path kullanılır

Method Eşleştirme

  • Method kontrolü en düşük önceliğe sahiptir
  • Belirtilmezse tüm HTTP methodları kabul edilir

Wildcard Hostname Kullanımı

Apinizer, host tanımlamalarında esneklik sağlamak için wildcard (joker karakter) kullanımını destekler. Wildcard hostname’ler, belirli bir pattern’e uyan tüm Host header değerlerinin koşulu sağlamasına ve böylece ilgili Route ile eşleşmesine olanak tanır.

Wildcard Kuralları

Wildcard Kuralları:
  • Domain’in en solundaki veya en sağındaki label’ında yalnızca bir adet asterisk (*) içerebilir
  • Asterisk, domain’in başında veya sonunda kullanılabilir

Wildcard Örnekleri

Sol Taraf Wildcard

*.example.com
Eşleşen Host’lar:
  • a.example.com
  • x.y.example.com
  • api.example.com
  • test.subdomain.example.com

Sağ Taraf Wildcard

example.*
Eşleşen Host’lar:
  • example.com
  • example.org
  • example.net
  • example.io

Örnek Senaryo

Aşağıdaki tabloda 5 farklı API Proxy ve bunlara tanımlanmış Client Route yapılandırmaları gösterilmektedir:
Proxy IDRelative PathMethodsHosts (OR)Headers (AND)
1/jokes--testmode:true, test:true
2/jokes-hostname_x.com, hostname_y.com-
3/jokes1/endpoint_x---
4/jokes1---
5/jokes---

Yönlendirme Örnekleri

Bu yapılandırmaya göre gelen istekler şu şekilde yönlendirilir:
İstek:
GET https://<ACCESS_URL>/jokes
Sonuç: Proxy 5’e yönlendirilir (herhangi bir koşul sağlanmadığı için varsayılan proxy)
Path eşleşti ancak host ve header koşulları sağlanmadığı için en basit yapılandırmaya sahip Proxy 5 seçilir.
İstek:
GET https://<ACCESS_URL>/jokes
Host: hostname_x.com
Sonuç: Proxy 2’ye yönlendirilir (host koşulu sağlandı)
Host önceliği header’dan yüksek olduğu için Proxy 2 seçilir.
İstek:
GET https://<ACCESS_URL>/jokes
testmode: true
Sonuç: Proxy 5’e yönlendirilir (Proxy 1 için her iki header gerekli, sadece biri sağlandı)
Header’lar AND mantığı ile çalıştığı için tüm header’ların eşleşmesi gerekir. Eksik header durumunda bir sonraki uygun proxy seçilir.
İstek:
GET https://<ACCESS_URL>/jokes
testmode: true
test: true
Sonuç: Proxy 1’e yönlendirilir (tüm header koşulları sağlandı)
Tüm header koşulları sağlandığı için Proxy 1 seçilir.
İstek:
GET https://<ACCESS_URL>/jokes1
Sonuç: Proxy 4’e yönlendirilir (path tam eşleşme)
Path önceliği en yüksek olduğu için tam eşleşen path’e sahip Proxy 4 seçilir.
İstek:
GET https://<ACCESS_URL>/jokes1/endpoint_x
Sonuç: Proxy 3’e yönlendirilir (daha spesifik path öncelikli)
Daha spesifik (uzun) path’ler, daha genel (kısa) path’lerden önce değerlendirilir.
İstek:
GET https://<ACCESS_URL>/jokes1/endpoint_x/endpoint_y
Sonuç: Proxy 3’e yönlendirilir (en yakın parent path eşleşmesi)
Tam eşleşme bulunamazsa, en yakın parent path kullanılır.
İstek:
GET https://<ACCESS_URL>/jokes1/endpoint_y
Sonuç: Proxy 4’e yönlendirilir (parent path olarak /jokes1 eşleşti)
/jokes1/endpoint_y path’i için tam eşleşme yok, bu yüzden parent path olan /jokes1 eşleşmesi kullanılır.
İstek:
GET https://<ACCESS_URL>/jokes
Host: hostname_x.com
testmode: true
test: true
Sonuç: Proxy 2’ye yönlendirilir (host, header’dan daha yüksek önceliğe sahip)
Host önceliği header’dan yüksek olduğu için, host koşulu sağlandığında header koşulları göz ardı edilir ve Proxy 2 seçilir.
İstek:
GET https://<ACCESS_URL>/jokes1
Host: hostname_x.com
testmode: true
test: true
Sonuç: Proxy 4’e yönlendirilir (path önceliği en yüksek, host ve header’lar göz ardı edilir)
Path önceliği en yüksek olduğu için, path eşleşmesi sağlandığında host ve header koşulları göz ardı edilir.

Routing Kombinasyon Tablosu

Bu tablo API Proxy açısından, API Proxy’nin nasıl seçildiğini göstermektedir:
DurumAçıklama
YokAPI proxy tanımında bulunmamaktadır. Client’ın gönderdiği kontrol edilmez.
EşleştiAPI proxy tanımında bulunmaktadır. Client’ın gönderdiği kontrol edilir, beklenen değeri gönderdi.
EşleşmediAPI proxy tanımında bulunmaktadır. Client’ın gönderdiği kontrol edilir, beklenen değeri göndermedi.
Aşağıdaki tablo, farklı kombinasyonlarda API Proxy’nin nasıl seçildiğini gösterir:
#HOSTPATHMETHODHEADERSONUÇAÇIKLAMA
1YokYokYokYok✓ SEÇİLİRHiçbir kriter tanımlı değil
2YokYokYokEşleşti✓ SEÇİLİRTüm tanımlı kriterler OK (HEADER)
3YokYokYokEşleşmedi✗ REDDEDİLİRHEADER eşleşmediği için routing yapılamaz
4YokYokEşleştiYok✓ SEÇİLİRTüm tanımlı kriterler OK (METHOD)
5YokYokEşleştiEşleşti✓ SEÇİLİRTüm tanımlı kriterler OK (METHOD, HEADER)
6YokYokEşleştiEşleşmedi✗ REDDEDİLİRHEADER eşleşmediği için routing yapılamaz
7YokYokEşleşmediYok✗ REDDEDİLİRMETHOD eşleşmediği için routing yapılamaz
8YokYokEşleşmediEşleşti✗ REDDEDİLİRMETHOD eşleşmediği için routing yapılamaz
9YokYokEşleşmediEşleşmedi✗ REDDEDİLİRMETHOD, HEADER eşleşmediği için routing yapılamaz
10YokEşleştiYokYok✓ SEÇİLİRTüm tanımlı kriterler OK (PATH)
11YokEşleştiYokEşleşti✓ SEÇİLİRTüm tanımlı kriterler OK (PATH, HEADER)
12YokEşleştiYokEşleşmedi✗ REDDEDİLİRHEADER eşleşmediği için routing yapılamaz
13YokEşleştiEşleştiYok✓ SEÇİLİRTüm tanımlı kriterler OK (PATH, METHOD)
14YokEşleştiEşleştiEşleşti✓ SEÇİLİRTüm tanımlı kriterler OK (PATH, METHOD, HEADER)
15YokEşleştiEşleştiEşleşmedi✗ REDDEDİLİRHEADER eşleşmediği için routing yapılamaz
16YokEşleştiEşleşmediYok✗ REDDEDİLİRMETHOD eşleşmediği için routing yapılamaz
17YokEşleştiEşleşmediEşleşti✗ REDDEDİLİRMETHOD eşleşmediği için routing yapılamaz
18YokEşleştiEşleşmediEşleşmedi✗ REDDEDİLİRMETHOD, HEADER eşleşmediği için routing yapılamaz
19YokEşleşmediYokYok✗ REDDEDİLİRPATH eşleşmediği için routing yapılamaz
20YokEşleşmediYokEşleşti✗ REDDEDİLİRPATH eşleşmediği için routing yapılamaz
21YokEşleşmediYokEşleşmedi✗ REDDEDİLİRPATH, HEADER eşleşmediği için routing yapılamaz
22YokEşleşmediEşleştiYok✗ REDDEDİLİRPATH eşleşmediği için routing yapılamaz
23YokEşleşmediEşleştiEşleşti✗ REDDEDİLİRPATH eşleşmediği için routing yapılamaz
24YokEşleşmediEşleştiEşleşmedi✗ REDDEDİLİRPATH, HEADER eşleşmediği için routing yapılamaz
25YokEşleşmediEşleşmediYok✗ REDDEDİLİRPATH, METHOD eşleşmediği için routing yapılamaz
26YokEşleşmediEşleşmediEşleşti✗ REDDEDİLİRPATH, METHOD eşleşmediği için routing yapılamaz
27YokEşleşmediEşleşmediEşleşmedi✗ REDDEDİLİRPATH, METHOD, HEADER eşleşmediği için routing yapılamaz
28EşleştiYokYokYok✓ SEÇİLİRTüm tanımlı kriterler OK (HOST)
29EşleştiYokYokEşleşti✓ SEÇİLİRTüm tanımlı kriterler OK (HOST, HEADER)
30EşleştiYokYokEşleşmedi✗ REDDEDİLİRHEADER eşleşmediği için routing yapılamaz
31EşleştiYokEşleştiYok✓ SEÇİLİRTüm tanımlı kriterler OK (HOST, METHOD)
32EşleştiYokEşleştiEşleşti✓ SEÇİLİRTüm tanımlı kriterler OK (HOST, METHOD, HEADER)
33EşleştiYokEşleştiEşleşmedi✗ REDDEDİLİRHEADER eşleşmediği için routing yapılamaz
34EşleştiYokEşleşmediYok✗ REDDEDİLİRMETHOD eşleşmediği için routing yapılamaz
35EşleştiYokEşleşmediEşleşti✗ REDDEDİLİRMETHOD eşleşmediği için routing yapılamaz
36EşleştiYokEşleşmediEşleşmedi✗ REDDEDİLİRMETHOD, HEADER eşleşmediği için routing yapılamaz
37EşleştiEşleştiYokYok✓ SEÇİLİRTüm tanımlı kriterler OK (HOST, PATH)
38EşleştiEşleştiYokEşleşti✓ SEÇİLİRTüm tanımlı kriterler OK (HOST, PATH, HEADER)
39EşleştiEşleştiYokEşleşmedi✗ REDDEDİLİRHEADER eşleşmediği için routing yapılamaz
40EşleştiEşleştiEşleştiYok✓ SEÇİLİRTüm tanımlı kriterler OK (HOST, PATH, METHOD)
41EşleştiEşleştiEşleştiEşleşti✓ SEÇİLİRTüm tanımlı kriterler OK (HOST, PATH, METHOD, HEADER)
42EşleştiEşleştiEşleştiEşleşmedi✗ REDDEDİLİRHEADER eşleşmediği için routing yapılamaz
43EşleştiEşleştiEşleşmediYok✗ REDDEDİLİRMETHOD eşleşmediği için routing yapılamaz
44EşleştiEşleştiEşleşmediEşleşti✗ REDDEDİLİRMETHOD eşleşmediği için routing yapılamaz
45EşleştiEşleştiEşleşmediEşleşmedi✗ REDDEDİLİRMETHOD, HEADER eşleşmediği için routing yapılamaz
46EşleştiEşleşmediYokYok✗ REDDEDİLİRPATH eşleşmediği için routing yapılamaz
47EşleştiEşleşmediYokEşleşti✗ REDDEDİLİRPATH eşleşmediği için routing yapılamaz
48EşleştiEşleşmediYokEşleşmedi✗ REDDEDİLİRPATH, HEADER eşleşmediği için routing yapılamaz
49EşleştiEşleşmediEşleştiYok✗ REDDEDİLİRPATH eşleşmediği için routing yapılamaz
50EşleştiEşleşmediEşleştiEşleşti✗ REDDEDİLİRPATH eşleşmediği için routing yapılamaz
51EşleştiEşleşmediEşleştiEşleşmedi✗ REDDEDİLİRPATH, HEADER eşleşmediği için routing yapılamaz
52EşleştiEşleşmediEşleşmediYok✗ REDDEDİLİRPATH, METHOD eşleşmediği için routing yapılamaz
53EşleştiEşleşmediEşleşmediEşleşti✗ REDDEDİLİRPATH, METHOD eşleşmediği için routing yapılamaz
54EşleştiEşleşmediEşleşmediEşleşmedi✗ REDDEDİLİRPATH, METHOD, HEADER eşleşmediği için routing yapılamaz
55EşleşmediYokYokYok✗ REDDEDİLİRHOST eşleşmediği için routing yapılamaz
56EşleşmediYokYokEşleşti✗ REDDEDİLİRHOST eşleşmediği için routing yapılamaz
57EşleşmediYokYokEşleşmedi✗ REDDEDİLİRHOST, HEADER eşleşmediği için routing yapılamaz
58EşleşmediYokEşleştiYok✗ REDDEDİLİRHOST eşleşmediği için routing yapılamaz
59EşleşmediYokEşleştiEşleşti✗ REDDEDİLİRHOST eşleşmediği için routing yapılamaz
60EşleşmediYokEşleştiEşleşmedi✗ REDDEDİLİRHOST, HEADER eşleşmediği için routing yapılamaz
61EşleşmediYokEşleşmediYok✗ REDDEDİLİRHOST, METHOD eşleşmediği için routing yapılamaz
62EşleşmediYokEşleşmediEşleşti✗ REDDEDİLİRHOST, METHOD eşleşmediği için routing yapılamaz
63EşleşmediYokEşleşmediEşleşmedi✗ REDDEDİLİRHOST, METHOD, HEADER eşleşmediği için routing yapılamaz
64EşleşmediEşleştiYokYok✗ REDDEDİLİRHOST eşleşmediği için routing yapılamaz
65EşleşmediEşleştiYokEşleşti✗ REDDEDİLİRHOST eşleşmediği için routing yapılamaz
66EşleşmediEşleştiYokEşleşmedi✗ REDDEDİLİRHOST, HEADER eşleşmediği için routing yapılamaz
67EşleşmediEşleştiEşleştiYok✗ REDDEDİLİRHOST eşleşmediği için routing yapılamaz
68EşleşmediEşleştiEşleştiEşleşti✗ REDDEDİLİRHOST eşleşmediği için routing yapılamaz
69EşleşmediEşleştiEşleştiEşleşmedi✗ REDDEDİLİRHOST, HEADER eşleşmediği için routing yapılamaz
70EşleşmediEşleştiEşleşmediYok✗ REDDEDİLİRHOST, METHOD eşleşmediği için routing yapılamaz
71EşleşmediEşleştiEşleşmediEşleşti✗ REDDEDİLİRHOST, METHOD eşleşmediği için routing yapılamaz
72EşleşmediEşleştiEşleşmediEşleşmedi✗ REDDEDİLİRHOST, METHOD, HEADER eşleşmediği için routing yapılamaz
73EşleşmediEşleşmediYokYok✗ REDDEDİLİRHOST, PATH eşleşmediği için routing yapılamaz
74EşleşmediEşleşmediYokEşleşti✗ REDDEDİLİRHOST, PATH eşleşmediği için routing yapılamaz
75EşleşmediEşleşmediYokEşleşmedi✗ REDDEDİLİRHOST, PATH, HEADER eşleşmediği için routing yapılamaz
76EşleşmediEşleşmediEşleştiYok✗ REDDEDİLİRHOST, PATH eşleşmediği için routing yapılamaz
77EşleşmediEşleşmediEşleştiEşleşti✗ REDDEDİLİRHOST, PATH eşleşmediği için routing yapılamaz
78EşleşmediEşleşmediEşleştiEşleşmedi✗ REDDEDİLİRHOST, PATH, HEADER eşleşmediği için routing yapılamaz
79EşleşmediEşleşmediEşleşmediYok✗ REDDEDİLİRHOST, PATH, METHOD eşleşmediği için routing yapılamaz
80EşleşmediEşleşmediEşleşmediEşleşti✗ REDDEDİLİRHOST, PATH, METHOD eşleşmediği için routing yapılamaz
81EşleşmediEşleşmediEşleşmediEşleşmedi✗ REDDEDİLİRHOST, PATH, METHOD, HEADER eşleşmediği için routing yapılamaz

Önemli Notlar

  • Relative path eşleştirmesi en yüksek önceliğe sahiptir
  • Daha spesifik (uzun) path’ler, daha genel (kısa) path’lerden önce değerlendirilir
  • Tam eşleşme bulunamazsa, en yakın parent path kullanılır
  • Birden fazla host tanımlanabilir
  • Hostlar OR mantığı ile çalışır
  • İstekteki host değeri, tanımlanan hostlardan herhangi biriyle eşleşirse koşul sağlanır
  • Birden fazla header tanımlanabilir
  • Header’lar AND mantığı ile çalışır
  • İstekte tanımlanan tüm header’lar mevcut olmalıdır
  • Eksik veya hatalı header durumunda bir sonraki uygun proxy’ye geçilir
  • Method kontrolü en düşük önceliğe sahiptir
  • Belirtilmezse tüm HTTP methodları kabul edilir
Client Route özelliği, API Gateway’inizde karmaşık yönlendirme senaryolarını kolayca yönetmenizi sağlar. Öncelik sırası ve eşleştirme mantığını doğru anlayarak, esnek ve güçlü API yönlendirme yapılandırmaları oluşturabilirsiniz.

İlgili Sayfalar