API Proxy'si geliştirme sürecinin önemli noktaları

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

Bu konuda, daha fazla bilgiye yönlendiren bağlantılarla birlikte API proxy'lerinin bazı temel özellikleri açıklanmaktadır.

API'ler bir uygulamanın başka bir uygulamanın özelliklerini kullanabilmesi için kullanılan giriş noktalarıdır. API oluşturmak için API proxy'leri uygularsınız

Apigee Edge'de API proxy mantığını, istemci kodundan gelen bir isteğe yanıt olarak yürütülen bir adım dizisi olarak yapılandırarak API proxy'leri uygularsınız. Kaynak yolları, HTTP fiili, gövde gereksinimleri vb. içeren bir URL içeren uç noktalar tanımlayarak istemcilere API proxy'si sunarsınız.

İstemci kodu açısından API proxy'si olarak adlandırılsa da API'dir.

API proxy'lerine genel bir bakış için API'leri ve API proxy'lerini anlama sayfasına bakın.

API proxy mantığının sırasını, akışları kullanarak belirlersiniz

Herhangi bir uygulamada veri akışı, koşul mantığının yönlendirdiği uygulama üzerinden gerçekleşir. Apigee Edge'de işleme yolu akışlardan oluşur. Akış, API proxy'sinin işleme yolunu oluşturan aşamalar (veya"adımlar") dizisidir. Akışlar, Apigee Edge'in istemciden arka uç kaynağına ve ardından tekrar istemciye kadar belirli yerlerde mantık ve davranış uygulayabilmenizi sağlayan yerlerdir.

Akışlar hakkında daha fazla bilgi için Proxy'nin akışlarla nasıl çalıştığını kontrol etme bölümüne bakın

Durum verilerine API proxy'leri tarafından oluşturulan akış değişkenleri üzerinden erişirsiniz

API proxy'si, yürütme durumunu temsil eden değişkenlere erişebilir. Bu değişkenlere, API proxy'lerinizi ve politikalarınızı yapılandıran XML'den erişebilirsiniz. Bunlara, API proxy'sini Java, JavaScript veya Python gibi prosedürel bir dille genişletirken de erişebilirsiniz.

Bu değişkenler Apigee Edge'de bulunur. Bunların bazıları, genellikle API proxy'lerinin yaptıklarında yaygındır (ör. bir HTTP isteğinin parçası oldukları için) varsayılan olarak bulunur. Mantık koşulunu karşılamak için kendi değişkenlerinizi de oluşturabilirsiniz.

Değişkenler hakkında daha fazla bilgi için Akış değişkenleriyle proxy durumunu yönetme bölümüne bakın.

API proxy'lerinin koşullu olarak yürütülmesini sağlayabilir

Çoğu programlama dilinde olduğu gibi API proxy'lerinde de kodun koşullu olarak yürütülmesini sağlayabilirsiniz. Koşullar genellikle akış değişkenleri üzerinden erişebileceğiniz API proxy durumunu temel alır. Örneğin, kullanıcı aracısını kontrol eden ve ardından isteği buna göre işleyen bir koşulunuz olabilir.

Koşullu yürütme hakkında daha fazla bilgi için Akış değişkenleri ve koşulları bölümüne bakın.

Çoğu mantığı bir API proxy'sinde politikaları kullanarak uygularsınız

API proxy'sine eklediğiniz mantığın çoğu politika olarak paketlenir. Politika, güvenlik veya trafik yönetimi gibi işlevsel bir alanın mantığını kapsayan bir Apigee Edge bileşenidir. Temel mantığın özelliklerini ayarlayan XML ile bir politika yapılandırırsınız. Politikaları bir akış içindeki "adımlar" sırasına göre düzenlersiniz. Böylece API proxy'niz, mantığı proxy'nizin hedefleri doğrultusunda en iyi şekilde yürütür.

Politikalarla ilgili daha fazla bilgi için Politika nedir? bölümüne bakın.

Yeniden kullanılabilir işlev grupları ekleyebilirsiniz.

API proxy'niz, kodunuzda diğer API proxy'leri gibi farklı yerlerden kullanılacak bir mantık içeriyorsa bu mantığı birden fazla yerden toplayabilirsiniz. Örneğin, güvenlik mantığını diğer API proxy'lerinin çağırdığı paylaşılan akışta gruplandırarak API proxy'leri arasındaki yinelemeleri azaltabilirsiniz.

Paylaşılan akışlar hakkında daha fazla bilgi için Yeniden kullanılabilir paylaşılan akışlar bölümünü inceleyin. API proxy'si zincirleme hakkında daha fazla bilgi için API proxy'lerini birbirine bağlama bölümüne bakın.

İzleme aracını kullanarak proxy'lerde hata ayıklayabilirsiniz

Apigee Edge, hata ayıklama ve test sırasında API proxy'nizin yürütme akışını incelemek için kullanabileceğiniz bir İzleme aracı içerir. Araç, bir istek için yürütülen her API proxy adımını görsel olarak sunar. Hata ayıklayıcıda olduğu gibi, her adımda API proxy durumunu oluşturan değişken değerlerinin listesini görüntüleyebilirsiniz.

Trace ile hata ayıklama hakkında daha fazla bilgi için İzleme aracını kullanma başlıklı makaleyi inceleyin.

API proxy hatalarını hata olarak işliyorsunuz

Hata işleyici yapılandırarak API istemcisine döndürülen hatayı özelleştirebilirsiniz. Hata işleyiciler, hatanın kendi kodunuzdan mı yoksa içerdiği bir bileşenden mi (politika gibi) kaynaklanıp kaynaklanmadığını belirleme konusunda hata mesajları üzerinde kontrol sahibi olmanızı sağlar.

Daha fazla bilgi için Hataları işleme bölümüne bakın.