Temel terminoloji

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

Apigee'de aynı anlamı taşıyan ve yaygın olarak karşılaşılan birkaç kavram vardır.

Terim Tanım
API

Uygulama programlama arayüzü: Bir uygulamanın başka bir uygulamanın özelliklerini veya verilerini kullanmasını kolaylaştıran arayüzdür.

API'ler, uygulama mantığına ve verilerine kararlı, basitleştirilmiş giriş noktaları tanımlayarak geliştiricilerin diğer geliştiriciler tarafından oluşturulan uygulama mantığına kolayca erişmelerini ve bunları yeniden kullanmalarını sağlar. Web API'leri söz konusu olduğunda bu mantık ve veriler ağ üzerinden herkese açık olarak gösterilir. API'leri kullanan uygulamalar değişikliklere karşı hassas olduğundan, API'ler bir sözleşme anlamına da gelir. Sözleşme, API'nin zaman içinde öngörülebilir bir şekilde değişeceğine dair bir miktar güvence sağlar.

Apigee, API'lerin yanı sıra API'leri geliştirme ve kullanma ile ilgili en iyi uygulamalar hakkında bol miktarda bilgi sağlar. Başlamak için API Design web yayını'na bakın veya ücretsiz e-kitabı indirin: Web API Design: The Missing Link Best Practices for Crafting Interfaces that Developers Loveing (Web API Tasarımı: Geliştiricilerin Sevdiği Arayüzler için En İyi Uygulamalar).

API proxy'si

Bir veya daha fazla API, genel HTTP hizmeti veya uygulama (ör. Node.js) için Edge'de ön cephe.

API proxy'si, Apigee Edge'in sağladığı bir dizi kaynağı temel alan bir dizi yapılandırma dosyası, politika ve kod olarak uygulanır. API proxy'leri, Apigee Edge yönetim kullanıcı arayüzü kullanılarak oluşturulup yapılandırılabilir veya bir metin düzenleyici ya da IDE'de yerel olarak uygulanabilir.

API proxy'si tarafından sunulan cephe, geliştiricilere yönelik API'yi arka uç hizmetlerinden ayırarak geliştiricileri kod değişikliklerine karşı korur ve şirket içi geliştirme ekiplerinizi etkilemeden uçta yenilik yapılmasını sağlar. Geliştirme ekipleri arka uç değişiklikleri yaparken geliştiriciler aynı arayüzü kesintisiz olarak çağırmaya devam eder. Apigee, aynı API'ye birden fazla arayüz sunmanıza olanak tanır. Böylece API'nin imzasını, çeşitli geliştirici alanlarının ihtiyaçlarını eş zamanlı olarak karşılayacak şekilde özelleştirebilirsiniz.

API temel yolu ve kaynakları

Ağ adresleri ve URI'ler tarafından tanımlanan API'ler. API, bir temel yol ve bir dizi API kaynağından oluşur. Her API proxy'si, bir temel yol ve isteğe bağlı olarak birden fazla API kaynak yolu tanımlar. API'leri, her biri ortak bir temel yolu paylaşan bir URI kümesi olarak düşünebilirsiniz.

Apigee, API'lerinizi yönetmeyi kolaylaştırmak için bu ham URI'leri görünen adlar ve açıklamalarla güçlendirir. Edge, URI'lere politika ve kod ekleyebilmenizi sağlayarak API'lerinizin davranışını ayrıntılı bir şekilde kontrol edip yönetmenizi sağlar.

API ürünü

Tasarım zamanında uygulama geliştiricilere yayınlanan, bir kota veya hizmet planı ile birlikte API kaynakları (URI'ler) koleksiyonu. API ürünleri, para kazanmak için API paketlerine dönüştürülebilir.

Bir API anahtarı bir veya daha fazla API ürününe bağlıdır. Bu sayede, uygulama ile uygulamanın kullanmasına izin verilen URI'lar paketi arasında bir bağlantı zorunlu kılınır.

API paketi Geliştiricilere paket halinde sunulan ve genellikle para kazanmada tanımlı bir ücret planıyla ilişkilendirilen API ürünlerinden oluşan bir koleksiyon.
uygulama

application (uygulama) kelimesinin kısaltmasıdır. Uygulama terimi, API'lerden yararlanan mobil uygulamaları ifade eder. Geliştiriciler, uygulamaları çeşitli programlama dillerinde, çeşitli teknolojiler ve platformlardan yararlanır. API'lerden yararlanmak isteyen geliştiriciler, uygulamalarını bir API sağlayıcının Apigee Edge kuruluşuna kaydettirir.

Uygulama kaydedildiğinde Apigee, uygulamayı tanımlayan bir API anahtarı ve gizli anahtar oluşturur. Geliştirici, API anahtarını uygulamaya yerleştirir. Burada, istek yapılırken anahtar sunulur. API Hizmetleri, güvenliği doğrudan API anahtarı doğrulaması veya OAuth aracılığıyla API anahtarı etrafında uygular.

ortam

API proxy'leri için çalışma zamanı yürütme bağlamı. API proxy'sinin, kullanıma sunduğu API'nin ağ üzerinden erişilebilir olabilmesi için önce bir ortama dağıtılması gerekir. Varsayılan olarak kuruluşlara iki ortam sağlanır: test ve prod.

  • Test ortamı genellikle geliştirme sırasında API proxy'lerini dağıtmak için kullanılır.
  • prod ortamı genellikle tamamen geliştirilip test edildikten sonra test ortamından API proxy'lerinin tanıtımı için kullanılır.
kuruluş

API proxy'leri, API ürünleri, API paketleri, uygulamalar ve geliştiriciler dahil olmak üzere bir Apigee Edge hesabındaki tüm nesnelerin kapsayıcısıdır.

Üyesi olduğunuz her kuruluş için bir kullanıcı hesabı gereklidir. (Çoğu kullanıcının yalnızca bir kuruluşta hesabı olur.)

politika

API proxy'si işleme akışında atomik, yeniden kullanılabilir bir mantık birimi olarak çalışan işleme adımıdır.

Politika tabanlı genel işlevler arasında mesaj biçimlerini dönüştürme, erişim denetimini zorunlu kılma, ek bilgi için uzak hizmetlere çağrı yapma, harici kullanıcılardan gelen hassas verileri maskeleme, olası tehditlere karşı mesaj içeriğini inceleme, performansı iyileştirmek için genel yanıtları önbelleğe alma ve daha pek çok işlem yer alır.

Politikalar, bir isteğin veya yanıt mesajının içeriğine ya da bağlamına göre koşullu olarak yürütülebilir. Örneğin, istek mesajı bir akıllı telefondan gönderildiyse yanıt biçimini özelleştirmek için bir dönüştürme politikası yürütülebilir.

API kaynak yolu RESTful kavramı olarak kaynak yolu, belirli bir kaynağa giden ağ yolunu tanımlayan tek tip kaynak tanımlayıcısıdır (URI).
sürüm

Geliştiriciye yönelik API arayüzünün sürümü.

Örneğin, pivotaltracker.com/services/v3 veya api.enterprise.apigee.com/v1.

Bu terim, sürüm kontrollü, bir API Proxy'sinde paketlenmiş yapılandırma ve politikalardan oluşan, numaralı, sürüm kontrollü bir yapılandırma paketi olan revision'dan farklıdır. API arayüzlerinin sürümleri vardır, API proxy'lerinin revizyonları vardır.

düzeltme API Proxy'sinde paketlenmiş, sürüm kontrollü bir yapılandırma ve politika paketi. Bu terim, geliştiricilere yönelik API arayüzü olan version'dan farklıdır. Yukarıdaki sürüme bakın.