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 üzerinden kullanma şeklini tanımlar. ProxyEndpoint, API proxy'sinin URL'sini ve bir proxy'nin nasıl davrandığını tanımlar: hangi politikaların uygulanacağı, hangi hedef uç noktalarına yönlendirileceği ve bu politikaların veya rota kurallarının yürütülmesi için karşılanması gereken koşullar.

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

Antipattern

Bir API proxy'sinde bir veya daha fazla proxy uç noktası olabilir. Birden fazla ProxyEndpoint tanımlamak, tek bir proxy'de birden fazla API'yi uygulamak için kolay ve basit bir mekanizmadır. Bu sayede, bir TargetEndpoint çağrılmadan önce ve çağrıldıktan sonra politikaları ve/veya iş mantığını yeniden kullanabilirsiniz.

Öte yandan, tek bir API proxy'sinde birden fazla ProxyEndpoint tanımladığınızda, kavramsal olarak birçok alakasız API'yi tek bir yapıda birleştirmiş olursunuz. Bu durum, API proxy'lerinin okunmasını, anlaşılmasını, hata ayıklanmasını ve bakımını zorlaştırır. Bu durum, API proxy'lerinin temel felsefesini (geliştiricilerin API oluşturup bakımını yapmasını kolaylaştırma) bozar.

Etki

Bir API proxy'sindeki birden fazla ProxyEndpoint:

  • Geliştiricilerin API proxy'sini anlamasını ve bakımını yapmasını zorlaştırır.
  • Analizleri karartma Varsayılan olarak, analiz verileri proxy düzeyinde toplanır. Özel raporlar oluşturmadığınız sürece metrikler proxy uç noktasına göre ayrılmaz.
  • 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 uygulamaları kullanın:

  1. Tek bir ProxyEndpoint'e sahip bir API proxy'si uygulayın.
  2. Ortak hedef sunucuyu paylaşan ve/veya hedef sunucunun çağrılmasından önce ya da sonra aynı mantığı gerektiren birden fazla API varsa bu mantığı farklı API proxy'lerinde uygulamak için paylaşılan akışları kullanabilirsiniz.
  3. Ortak bir başlangıç temel yolunu paylaşan ancak sonek bakımından farklılık gösteren birden fazla API varsa tek bir ProxyEndpoint'te koşullu akışlar kullanın.
  4. Birden fazla ProxyEndpoint'e sahip bir API proxy'si varsa ve bu API proxy'sinde sorun yoksa herhangi bir işlem yapmanız gerekmez.

API proxy'si başına bir ProxyEndpoint kullanmak şu sonuçlara yol açar:

  1. Daha basit ve kolayca sürdürülebilen proxy'ler
  2. Analytics'teki daha iyi bilgiler (ör. proxy performansı ve hedef yanıt süresi), tüm ProxyEndpoint'ler için özetlenmek yerine ayrı ayrı raporlanacak.
  3. Daha hızlı sorun giderme ve sorun çözümü

Daha fazla bilgi