Antipattern: API proxy'sinde birden fazla ProxyEndpoint tanımlama

Apigee Edge belgelerini görüntülüyorsunuz.
Apigee X belgelerine gidin.
bilgi

ProxyEndpoint yapılandırması, istemci uygulamalarının API'leri Apigee Edge aracılığıyla nasıl kullandığını tanımlar. ProxyEndpoint, API proxy'sinin URL'sini ve bir proxy'nin nasıl davranacağını tanımlar: Hangi politikaların uygulanacağı, hangi hedef uç noktalara yönlendirme yapılacağı ve bu politikaların veya yönlendirme kurallarının yürütülmesi için karşılanması gereken koşullar.

Kısacası, ProxyEndpoint yapılandırması bir API'yi uygulamak için yapılması gereken her şeyi tanımlar.

Antipattern

Bir API proxy'sinin bir veya daha fazla proxy uç noktası olabilir. Birden fazla ProxyEndpoint tanımlamak, tek bir proxy'de birden çok API uygulamak için kolay ve basit bir mekanizmadır. Bu, bir TargetEndpoint'in çağrılmasından önce ve sonra politikaları ve/veya iş mantığını yeniden kullanmanızı sağlar.

Diğer yandan, tek bir API proxy'sinde birden fazla ProxyEndpoint tanımlarken birçok alakasız API'yi kavramsal olarak tek bir yapıda birleştirirsiniz. API proxy'lerinin okunmasını, anlaşılmasını, hatalarını ayıklamasını ve bakımını zorlaştırır. Bu da API proxy'lerinin temel felsefesini ortadan kaldırır: geliştiricilerin API oluşturup sürdürmesini kolaylaştırır.

Etki

API proxy'sindeki birden fazla ProxyEndpoint aşağıdakileri yapabilir:

  • Geliştiricilerin API proxy'sini anlamasını ve sürdürmesini zorlaştırın.
  • Analizleri karartın. Analiz verileri varsayılan olarak proxy düzeyinde toplanır. Özel raporlar oluşturmadığınız sürece proxy uç noktasına göre metriklerin dökümü sunulmaz.
  • API proxy'leriyle ilgili sorunların giderilmesini zorlaştırır.

En iyi uygulama

Yeni bir API proxy'si uygularken veya mevcut bir API proxy'sini yeniden tasarlarken aşağıdaki en iyi uygulamalardan yararlanın:

  1. Tek bir ProxyEndpoint ile bir API proxy'si uygulayın.
  2. Ortak hedef sunucuyu paylaşan birden fazla API varsa ve/veya hedef sunucunun çağrı öncesi veya sonrası aynı mantığı gerektiren birden fazla API varsa bu tür bir mantığı farklı API proxy'lerinde uygulamak için paylaşılan akışlar kullanabilirsiniz.
  3. Ortak bir başlangıç temel yolunu paylaşan ancak son ekte farklılık gösteren birden fazla API varsa tek bir ProxyEndpoint'te koşullu akışlar kullanın.
  4. Birden fazla ProxyEndpoint'i olan bir API proxy'si varsa ve bu proxy ile ilgili sorun yoksa herhangi bir işlem yapmanız gerekmez.

Her API proxy'si için bir ProxyEndpoint kullanılması şunlara neden olur:

  1. Daha basit, proxy'lerin yönetimi daha kolay
  2. Analytics'te bulunan daha iyi bilgiler (ör. proxy performansı ve hedef yanıt süresi), tüm ProxyEndpoints için toplanmak yerine ayrı ayrı raporlanacak
  3. Daha hızlı sorun giderme ve çözme

Daha fazla bilgi