Temel terminoloji

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

Apigee'de, ortak fikirlere sahip ancak benzersiz anlamlara sahip olan çeşitli kavramlar 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üz.

API'ler, uygulama mantığına ve verilere sabit, basitleştirilmiş giriş noktaları tanımlayarak geliştiricilerin diğer geliştiriciler tarafından oluşturulan uygulama mantığına kolayca erişip bu mantığı yeniden kullanmasını sağlar. Web API'leri söz konusu olduğunda bu mantık ve veriler ağ üzerinden paylaşılır. API'leri kullanan uygulamalar değişikliklere karşı hassas olduğundan API'ler bir sözleşmeyi de ifade eder. Sözleşme, API'nin zaman içinde tahmin edilebilir bir şekilde değişeceği konusunda belirli bir düzeyde güvence sağlar.

Apigee, API'ler ve bunları geliştirme ve kullanmayla ilgili en iyi uygulamalar hakkında zengin bilgi sağlar. Başlamak için API Design webcast (API Tasarımı web yayınını) inceleyin veya ücretsiz e-kitabı Web API Design: The Missing Link Best Practices for Crafting Interfaces that Developers Love (Web API Tasarımı: Geliştiricilerin Sevdiği Arayüzler Oluşturmak İçin Eksik Halka En İyi Uygulamaları) indirin.

API proxy'si

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

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şturulabilir ve yapılandırılabilir ya da yerel olarak bir metin düzenleyicide veya IDE'de uygulanabilir.

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

API ana yolu ve kaynakları

Ağ adresleri ve URI'ler tarafından tanımlanan API'ler. API'ler, bir temel yoldan 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, ortak bir temel yolu paylaşan URI'ler 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 destekler. Edge, URI'lere politika ve kod eklemenize olanak tanır. Böylece API'lerinizin davranışını ayrıntılı bir şekilde kontrol edebilir ve yönetebilirsiniz.

API ürünü

Tasarım aşamasında uygulama geliştiricilere yayınlanan, bir kota veya hizmet planıyla birleştirilmiş API kaynağı (URI) koleksiyonu. API ürünleri de para kazanmak için API paketleri halinde gruplandırılabilir.

API anahtarı, bir veya daha fazla API ürünüyle bağlanır. Böylece, uygulama ile uygulamanın kullanmasına izin verilen URI paketi arasında bir bağlama uygulanır.

API paketi Geliştiricilere paket olarak sunulan ve genellikle para kazanmada tanımlanan bir ücret planıyla ilişkilendirilen API ürünleri koleksiyonu.
uygulama

Uygulama'nın kısaltması. Uygulama terimi, API kullanan mobil uygulamaları ifade eder. Geliştiriciler, çeşitli programlama dilleri, teknolojiler ve platformlar kullanarak uygulamaları uygular. API'leri kullanmak isteyen geliştiriciler, Apigee Edge'de bir API sağlayıcının kuruluşuna uygulama 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, istek yapılırken sunulur. API Hizmetleri, API anahtarının güvenliğini doğrudan API anahtarı doğrulaması veya OAuth aracılığıyla uygular.

ortam

API proxy'leri için çalışma zamanı yürütme bağlamı. Bir API proxy'sinin, sağladığı API'ye ağ üzerinden erişilebilmesi için bir ortama dağıtılması gerekir. Varsayılan olarak, kuruluşlar için iki ortam temel hazırlığı yapılı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 API proxy'lerinin tamamen geliştirilip test edildikten sonra test ortamından tanıtılması için kullanılır.
kuruluş

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

Üyesi olduğunuz her kuruluş için bir kullanıcı hesabı gerekir. (Kullanıcıların çoğu yalnızca bir kuruluşta hesap sahibidir.)

politikası

API proxy işleme akışında atomik, yeniden kullanılabilir bir mantık birimi olarak yürütülen bir 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 bilgi için uzak hizmetleri çağırma, harici kullanıcılardan gelen hassas verileri maskeleme, olası tehditler için mesaj içeriğini inceleme, performansı artırmak amacıyla sık kullanılan yanıtları önbelleğe alma vb. bulunur.

Politikalar, 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üşüm 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ştiricilere yönelik API arayüzünün sürümü.

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

Bu terim, API Proxy'sinde birleştirilen yapılandırma ve politikaların numaralandırılmış, sürüm kontrollü paketi olan revizyon'dan farklıdır. API arayüzlerinin sürümleri, API proxy'lerinin ise revizyonları vardır.

düzeltme API proxy'sinde gruplandırılmış, numaralı ve sürüm kontrollü bir yapılandırma ve politika paketi. Bu terim, geliştiricilere yönelik API arayüzü olan sürüm ile birbirinden farklıdır. Yukarıdaki sürüme bakın.