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

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

ProxyEndpoint yapılandırması, istemci uygulamalarının Apigee Edge üzerinden API'leri kullanma şeklini tanımlar. ProxyEndpoint, API proxy'sinin URL'sini ve proxy'nin nasıl davrandığını tanımlar: hangi politikaların uygulanacağı ve hangi hedef uç noktaların yönlendirileceği, ayrıca bu politikaların veya yönlendirme kurallarının uygulanması için karşılanması gereken koşullar.

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

Antipattern

API proxy'sinde bir veya daha fazla proxy uç noktası bulunabilir. 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, birbirinden bağımsız birçok API'yi kavramsal olarak tek bir yapıda birleştirmiş olursunuz. Bu, API proxy'lerinin okunmasını, anlaşılmasını, hata ayıklanmasını ve sürdürülmesini zorlaştırır. Bu, API proxy'lerinin temel felsefesini (geliştiricilerin API oluşturmasını ve yönetmesini kolaylaştırmak) geçersiz kılar.

Etki

API proxy'sinde birden fazla ProxyEndpoint şunları yapabilir:

  • Geliştiricilerin API proxy'sini anlamasını ve sürdürmesini zorlaştırır.
  • Analizleri karartın. Analiz verileri varsayılan olarak proxy düzeyinde toplanır. Özel raporlar oluşturmadığınız sürece metriklerin proxy uç noktasına göre dökümü yoktur.
  • API proxy'leriyle ilgili sorunları gidermeyi 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 ile bir API proxy'si uygulayın.
  2. Ortak hedef sunucuya sahip ve/veya hedef sunucunun çağrılmasından önce veya sonra aynı mantığı gerektiren birden fazla API varsa bu tür mantığı farklı API proxy'lerinde uygulamak için paylaşılan akışları kullanabilirsiniz.
  3. Ortak bir başlangıç temel yolunu paylaşan ancak son eklerinde farklılık gösteren birden fazla API varsa tek bir ProxyEndpoint'te koşullu akışlar kullanın.
  4. Birden fazla ProxyEndpoint içeren bir API proxy'si varsa ve bu proxy'de herhangi bir sorun yoksa herhangi bir işlem yapmanız gerekmez.

API proxy'si başına bir ProxyEndpoint kullanılması aşağıdakilere yol açar:

  1. Daha basit ve daha kolay yönetilen proxy'ler
  2. Analytics'te proxy performansı ve hedef yanıt süresi gibi daha iyi bilgiler, tüm ProxyEndpoints için birleştirilmek yerine ayrı ayrı raporlanır.
  3. Daha hızlı sorun giderme ve sorun çözme

Daha fazla bilgi