Temel terminoloji

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

Apigee'de benzersiz bir anlamı olan birkaç yaygın fikir 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 bir arayüzdür.

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

Apigee, API'ler ve bunları geliştirip kullanmayla ilgili en iyi uygulamalar hakkında zengin bilgiler sunar. Başlamak için API Tasarımı web yayınını izleyin veya ücretsiz e-kitabı indirin: Web API Tasarımı: Geliştiricilerin Sevdiği Arayüzleri Oluşturmaya Yönelik En İyi Uygulamalar.

API proxy'si

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

API proxy'si, Apigee Edge tarafından sağlanan bir dizi kaynağa dayanan 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üzenleyicide ya da IDE'de yerel olarak uygulanabilir.

API proxy'si tarafından sağlanan cephe, geliştiriciye yönelik API'yi arka uç hizmetlerinden ayırarak geliştiricileri kod değişikliklerinden korur ve dahili geliştirme ekiplerinizi etkilemeden uçta yenilik yapmanızı sağlar. Geliştirme ekipleri arka uçta değişiklikler 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, bir API'nin imzasını aynı anda çeşitli geliştirici nişlerinin ihtiyaçlarını karşılayacak şekilde özelleştirebilirsiniz.

API temel yolu ve kaynakları

Ağ adresleri ve URI'ler tarafından tanımlanan API'ler. API, temel yol ve bir dizi API kaynağı içerir. Her API proxy'si bir temel yol ve isteğe bağlı olarak birden fazla API kaynağı yolu tanımlar. API'yi, tümü 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 zenginleştirir. Edge, URI'lere politika ve kod eklemenize olanak tanır. Bu sayede API'lerinizin davranışını ayrıntılı bir şekilde kontrol edebilir ve yönetebilirsiniz.

API ürünü

Bir kota veya hizmet planı ile birlikte kullanılan API kaynakları (URI'ler) koleksiyonu. Bu koleksiyon, tasarım zamanında uygulama geliştiricilerle paylaşılır. API ürünleri, para kazanma için API paketleri halinde gruplandırılabilir.

API anahtarı, bir veya daha fazla API ürününe bağlıdır. Bu sayede, bir uygulama ile uygulamanın kullanmasına izin verilen URI paketi arasında bağlama uygulanır.

API paketi Geliştiricilere paket olarak sunulan ve genellikle para kazanma bölümünde tanımlanan bir ücret planıyla ilişkilendirilen API ürünleri koleksiyonu.
uygulama

Uygulama kelimesinin kısaltması. Uygulama terimi, API'leri kullanan mobil uygulamaları ifade etmek için kullanılır. Geliştiriciler, uygulamaları çeşitli programlama dillerinde, çeşitli teknolojiler ve platformlar kullanarak uygular. API'leri kullanmak isteyen geliştiriciler, uygulamaları Apigee Edge'de bir API sağlayıcının kuruluşuna kaydeder.

Uygulama kaydedildiğinde Apigee, uygulamayı tanımlayan bir API anahtarı ve gizli anahtar oluşturur. Geliştirici, API anahtarını uygulamaya yerleştirir. Bu anahtar, istekte bulunurken sunulur. API Hizmetleri, doğrudan API anahtarı doğrulama veya OAuth aracılığıyla API anahtarı etrafında güvenlik uygular.

ortam

API proxy'leri için bir çalışma zamanı yürütme bağlamı. Bir API proxy'sinin, ağ üzerinden erişilebilir olması için 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.
  • Üretim ortamı genellikle API proxy'lerini tam olarak geliştirilip test edildikten sonra test ortamından yükseltmek 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 bulunduğu kapsayıcı.

Üyesi olduğunuz her kuruluş için bir kullanıcı hesabı gerekir. (Çoğu kullanıcı yalnızca bir kuruluşa ait bir hesaba sahiptir.)

politikası

Bir API proxy işleme akışında atomik ve yeniden kullanılabilir bir mantık birimi olarak yürütülen işleme adımı.

Politikaya dayalı tipik işlevler arasında mesaj biçimlerini dönüştürme, erişim denetimini zorunlu kılma, ek bilgiler için uzak hizmetleri çağırma, hassas verileri harici kullanıcılardan maskeleme, mesaj içeriğini olası tehditlere karşı inceleme, performansı artırmak için yaygın yanıtları önbelleğe alma vb. yer alır.

Politikalar, bir istek 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 bir kavram olan kaynak yolu, belirli bir kaynağın ağ yolunu tanımlayan tekdüzen 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, bir API proxy'sine paketlenmiş yapılandırma ve politikaların numaralandırılmış, sürüm kontrollü paketi olan revizyon ile karıştırılmamalıdır. API arayüzlerinin sürümleri, API proxy'lerinin ise revizyonları vardır.

düzeltme API proxy'sine paketlenmiş, sürüm denetimli ve numaralandırılmış bir yapılandırma ve politika paketi. Bu terim, geliştiricilere yönelik API arayüzü olan sürümden farklıdır. Yukarıdaki sürüme bakın.