Apigee Edge belgelerini görüntülüyorsunuz.
Apigee X belgelerine gidin. info
Bu konuda, SOAP tabanlı web hizmetleri için API proxy'lerinin nasıl oluşturulacağı açıklanmaktadır. Edge'de iki tür SOAP proxy oluşturabilirsiniz. Bunlardan biri arka uç SOAP hizmetine RESTful arayüzü oluştururken diğeri SOAP mesajını arka uca "geçirmektedir". Her iki teknik de bu konuda açıklanmıştır.
Bu videoda, API proxy sihirbazı kullanılarak Apigee Edge ile bir SOAP hizmetinin REST hizmetine dönüştürülmesinin uçtan uca bir demosu sunulmaktadır. Ancak SOAP'tan REST'e dönüşüm üzerinde daha fazla kontrol sahibi olmak istiyorsanız politikaları kullanarak bir proxy oluşturabilirsiniz. Daha fazla bilgi için Eğitim: Apigee Edge'de SOAP'tan REST API proxy'sine manuel olarak yapı oluşturma başlıklı makaleyi inceleyin.
SOAP tabanlı bir hizmet için RESTful API proxy'si oluşturma
Bu bölümde, Proxy Oluştur sihirbazındaki REST to SOAP to REST (REST to SOAP to REST) seçeneğiyle RESTful SOAP API proxy'sinin nasıl oluşturulacağı açıklanmaktadır.
Genel Bakış
REST'ten SOAP'a ve REST'e seçeneği, RESTful API proxy'si oluşturmak için WSDL'yi işler. Edge, hizmetin desteklenen işlemlerini, giriş parametrelerini vb. WSDL'den belirler. Edge, her işlem için hangi HTTP yönteminin kullanılacağını "tahmin eder". Edge genellikle işlemleri, önbelleğe alınabilme avantajına sahip GET isteklerine dönüştürür. Edge, SOAP işlemine göre değişebilen arka uç hedef uç noktasını da ayarlar.
Edge, bu tür proxy'ler için API dokümanı oluşturmak üzere kullanabileceğiniz bir OpenAPI spesifikasyonu otomatik olarak oluşturur.
Temel adımlar
Edge
Edge kullanıcı arayüzünü kullanarak SOAP tabanlı hizmet için RESTful API proxy'si oluşturmak üzere:
- apigee.com/edge adresinde oturum açın.
- Sol gezinme çubuğunda Geliştirme > API Proxy'leri'ni seçin.
- +Proxy'yi tıklayın.
- SOAP hizmeti'ni tıklayın.
- Proxy ayrıntıları sayfasında WSDL dosyasını sağlayın.
Alan Açıklama WSDL dosyası sağlama WSDL'nin kaynağını seçin.
- Web adresinden (URL): WSDL'nin URL'sini girin veya yapıştırın.
- Bilgisayarımdan: Yerel dizininizden bir WSDL dosyası yükleyin. Bağımlılıklar varsa birden fazla dosya yükleyebilirsiniz.
- WSDL'yi doğrulamak için Doğrula'yı tıklayın.
- Aşağıdaki proxy ayrıntılarını girin:
Alan Açıklama Ad API'niz için görüntülenen ad. Alfanümerik karakterler, kısa çizgi (-) veya alt çizgi (_) belirtin. Temel yol API proxy'nizin http(s)://[ana makine] adresinin ardından görünen URI fragmanı. Edge, gelen istek mesajlarını eşleştirmek ve uygun API proxy'sine yönlendirmek için temel yol URI'sini kullanır.
NOT: API proxy ana yolu varsayılan olarak
Namealanı için belirtilen ve küçük harflere dönüştürülen değerdir.Temel yolun ardından ek kaynak URL'leri gelir. İstemcilerin API proxy'nizi çağırmak için kullanacağı tam URL yapısı aşağıda verilmiştir:
https://[host]/base_path/conditional_flow_pathNOT: Temel yol benzersiz olmalıdır. Aynı temel yola sahip iki API proxy'si dağıtamazsınız. Dağıtılmış bir API proxy'sini düzenleyip taban yolunu başka bir API proxy'sinin taban yoluyla aynı değere ayarlarsanız Edge, kaydettiğinizde API proxy'sini otomatik olarak dağıtımdan kaldırır. API proxy'sini yeniden dağıtmadan önce, ana yolu benzersiz olacak şekilde düzenlemeniz gerekir.
Temel yollarda joker karakterleri kullanma
API proxy'lerinizi geleceğe hazır hale getirmek için API proxy temel yollarında bir veya daha fazla
/*/joker karakteri kullanın. Örneğin,/team/*/memberstemel yolu, istemcilerin yeni ekipleri desteklemek için yeni API proxy'leri oluşturmanıza gerek kalmadanhttps://[host]/team/blue/membersvehttps://[host]/team/green/membersçağrılarına izin verir./**/desteklenmez.Açıklama (İsteğe bağlı) API'nin açıklaması. - İleri'yi tıklayın.
- Sihirbazın Ortak politikalar sayfasında aşağıdakileri yapılandırın:
- Güvenlik: Yetkilendirme bölümündeki güvenlik yetkilendirme şartları. Güvenlik ekleme başlıklı makaleyi inceleyin.
- Güvenlik: Tarayıcı bölümünde, kaynaklar arası kaynak paylaşımı (CORS) desteği. CORS desteği ekleme başlıklı makaleyi inceleyin.
- Kota bölümünde, arka uç hizmetinizi yüksek trafikten korumak için kotalar. Kotalar başlıklı makaleyi inceleyin. (Geçiş yetkilendirmesi seçiliyse kullanılamaz.)
- WSDL işlemleri sayfasında REST to SOAP to REST (REST to SOAP to REST) API proxy türünü seçin.
Edge'in WSDL dosyasında "keşfettiği" işlemleri listeleyen bir tablo gösterilir. API proxy'nize dahil etmek istediğiniz işlemleri seçip yapılandırabilirsiniz. Tablo aşağıdaki şekilde gösterilmiştir.
- Kullanmak istediğiniz işlem grubunu belirtmek için açılır menüden bir Bağlantı Noktası Türü seçin. WSDL'de bağlantı noktası türü öğeleri, bir web hizmetinde çağırabileceğiniz işlemleri tanımlar.
- İsteğe bağlı olarak, bir işlem için REST API Yolu'nu değiştirin. Yol, API proxy URL'sinde kaynak adı olarak kullanılır.
- İsteğe bağlı olarak işlemle ilişkili Fiil'i (HTTP yöntemi) değiştirebilirsiniz.
- İleri'yi tıklayın.
- Sihirbazın Sanal ana makineler sayfasında, API proxy'sinin dağıtıldığında bağlanacağı sanal ana makineleri seçin. Daha fazla bilgi için Sanal ana makineler hakkında başlıklı makaleyi inceleyin.
- İleri'yi tıklayın.
- Dağıtım ortamlarını seçin ve Oluştur ve dağıt'ı tıklayın
Yeni API proxy'niz oluşturulur ve seçilen ortama dağıtılır. - API proxy'sinin ayrıntılar sayfasını görüntülemek için Proxy'yi düzenle'yi tıklayın.
Klasik Edge (Private Cloud)
Klasik Edge kullanıcı arayüzünü kullanarak SOAP tabanlı hizmet için RESTful API proxy'si oluşturmak üzere:
http://ms-ip:9000adresinde oturum açın. ms-ip, Yönetim Sunucusu düğümünün IP adresi veya DNS adıdır.- Üst gezinme çubuğunda API'ler > API Proxy'leri'ni seçin.
- + API Proxy'sini tıklayın.
- Proxy Oluştur sihirbazında SOAP hizmetini seçin.
- İleri'yi tıklayın.
- Ayrıntılar sayfasında aşağıdaki seçimleri yapın. Bir WSDL seçtikten sonra Doğrula'yı tıklamanız gerekir.
Bu alanda bunu yap WSDL WSDL'nin kaynağını seçin.
- URL: Kullanmak istediğiniz WSDL'nin URL'sini girin.
- Dosya: Dosya sisteminizde bir WSDL dosyası seçin. Ek bağımlı dosyaların bulunduğu durumlarda bunların tümünü seçebilirsiniz.
- Örnek URL: Herkese açık web hizmetleri için WSDL listesinden seçim yapın. Bunlar, Edge'in SOAP/API proxy özelliklerini denemek için kullanışlıdır.
Proxy Adı Bu, oluşturduğunuz proxy'nin adıdır.
Proxy Ana Yolu API proxy'nizin http(s)://[ana makine] adresinden sonra görünen URI fragmanı. Edge, gelen istek mesajlarını eşleştirmek ve uygun API proxy'sine yönlendirmek için temel yol URI'sini kullanır.
Not: API proxy temel yolu varsayılan olarak
Namealanı için belirtilen ve tümüyle küçük harfe dönüştürülen değerdir.Temel yolun ardından ek kaynak URL'leri gelir. İstemcilerin API proxy'nizi çağırmak için kullanacağı tam URL yapısı aşağıda verilmiştir:
https://[host]/base_path/conditional_flow_pathNot: Temel yol benzersiz olmalıdır. Aynı temel yola sahip iki API proxy'si dağıtamazsınız. Dağıtılmış bir API proxy'sini düzenleyip taban yolunu başka bir API proxy'sinin taban yoluyla aynı değere ayarlarsanız Edge, kaydettiğinizde API proxy'sini otomatik olarak dağıtımdan kaldırır. API proxy'sini yeniden dağıtmadan önce ana yolu benzersiz olacak şekilde düzenlemeniz gerekir.
Temel yollarda joker karakterleri kullanma
API proxy'lerinizi geleceğe hazır hale getirmek için API proxy temel yollarında bir veya daha fazla
/*/joker karakteri kullanın. Örneğin,/team/*/memberstemel yolu, istemcilerin yeni ekipleri desteklemek için yeni API proxy'leri oluşturmanıza gerek kalmadanhttps://[host]/team/blue/membersvehttps://[host]/team/green/membersçağrılarına izin verir./**/desteklenmez.Açıklama Proxy'nin kısa bir açıklaması. - İleri'yi tıklayın.
- WSDL sayfasında REST to SOAP to REST (REST to SOAP to REST) API proxy türünü seçin.
Edge'in WSDL dosyasında "keşfettiği" işlemleri listeleyen bir tablo gösterilir. API proxy'nize dahil etmek istediğiniz işlemleri seçip yapılandırabilirsiniz. Tablo aşağıdaki şekilde gösterilmiştir.
- Bağlantı noktası türü sütunundan kullanmak istediğiniz işlem grubunu seçin. WSDL'de bağlantı noktası türü öğeleri, bir web hizmetinde çağırabileceğiniz işlemleri tanımlar.
- İsteğe bağlı olarak işlemle ilişkili HTTP yöntemini değiştirin.
Not: Edge, her işlem için kullanılacak HTTP yöntemini belirlerken "en iyi tahmini" yapar. GET istekleri önbelleğe alınabildiği için genellikle GET tercih edilir.
- İsteğe bağlı olarak bir işlemin REST API yolunu değiştirebilirsiniz. Yol, API proxy URL'sinde kaynak adı olarak kullanılır.
- Güvenlik eklemek, sanal ana makineleri ve dağıtım ortamını seçmek için sihirbazın geri kalanını tıklayın.
- Derleme sayfasında Derle ve Yayınla'yı tıklayın. Edge, WSDL'ye göre yeni API proxy'sini oluşturur ve dağıtır.
- Yeni API proxy'sinin özet sayfasına gidin. WSDL dosyasında keşfedilen işlemlere göre bir dizi kaynağın oluşturulduğunu unutmayın.
Proxy'nin Genel Bakış sayfasında, Kaynaklar listesinde yeni API'nin, işlemlerinin ve parametrelerinin ayrıntılı bir açıklaması sağlanır. Bu temsili, API'nin referans dokümanı olarak düşünebilirsiniz. Edge, API modelinin bu görünümünü sizin için otomatik olarak oluşturur. Açıklamasını ve yol bilgilerini görmek için kaynağı genişletmeniz yeterlidir.
Nihai proxy hakkında
Edge, WSDL'ye dayalı bir API proxy oluşturduğunda, ortaya çıkan proxy aslında verileri dönüştürme, değişkenleri ayıklayıp ayarlama, mesajları değiştirme ve daha fazlasıyla ilgili politikaları içeren karmaşık bir akıştır. WSDL'ye dayalı bir proxy oluşturduktan sonra, API yönetim kullanıcı arayüzünün Geliştirme görünümünde ortaya çıkan akışa göz atın. Burada, hangi politikaların eklendiğini tam olarak görebilirsiniz.
Örneğin, istek tarafında hedef URL'yi ayarlamak için bir AssignMessage politikası kullanılır. Yanıt tarafında, politikalar yanıtı XML'den JSON'a dönüştürmek, yanıtın SOAP gövde bölümünü bir değişkene ayıklamak ve yanıt mesajını ayarlamak için yürütülür. Bu politikalar (ve diğerleri) proxy'yi oluşturduğunuzda otomatik olarak eklenir.
OpenAPI Spec: Bu proxy için otomatik olarak oluşturulan OpenAPI Spec'i görüntülemek üzere http(s)://[proxy_domain]/[proxy_base_path]/openapi.json adresini ziyaret edin. Ancak bir XML şemasının tüm kuralları OpenAPI spesifikasyonunda temsil edilemediğinden dönüşüm her zaman doğru değildir.
SOAP tabanlı bir hizmete geçiş proxy'si oluşturma
Bu bölümde, Yeni Proxy Oluştur iletişim kutusunda Geçiş Proxy'si seçeneğiyle geçiş proxy'sinin nasıl oluşturulacağı açıklanmaktadır.
Genel Bakış
Geçiş Proxy'si seçeneği, bir istekteki SOAP mesajını arka uç hizmetine "dokunmadan" ileten bir proxy oluşturmanıza olanak tanır. Bu sayede, SOAP tabanlı bir web hizmeti için proxy oluşturmak çok kolay hale gelir. Edge, arka planda tüm dönüşümleri ve diğer akış etkinliklerini sizin için otomatik olarak yönetir. Örneğin, istek JSON biçimindeyse Edge, hizmete POST göndermeden önce isteklerini doğru ad alanlarının bulunduğu geçerli bir XML SOAP mesajına dönüştürmek için gerekli adımları atar. Benzer şekilde, hizmet XML tabanlı bir SOAP yanıtı döndürdüğünde Edge, istemciye döndürmeden önce yanıtı JSON'a çevirir. Ayrıca Edge, arka uç hedef uç noktasını oluşturur. Bu uç nokta, SOAP işlemine göre değişiklik gösterebilir.
Bu tür proxy'lerde Edge, WSDL'yi barındırır ve proxy'de buna erişmenizi sağlayacak bir akış oluşturur. Edge tarafından barındırılan bu WSDL'nin adresi (http(s)://[proxy_domain]/[proxy_base_path]?wsdl), SOAP hizmetini proxy üzerinden çağıran istemciler için yeni hizmet uç noktası URL'si olur.
Temel adımlar
Edge
Edge kullanıcı arayüzünü kullanarak SOAP tabanlı bir hizmete geçiş proxy'si oluşturmak için:
- apigee.com/edge adresinde oturum açın.
- Sol gezinme çubuğunda Geliştirme > API Proxy'leri'ni seçin.
- +Proxy'yi tıklayın.
- SOAP hizmeti'ni tıklayın.
- Proxy ayrıntıları sayfasında WSDL ayrıntılarını sağlayın.
Alan Açıklama WSDL WSDL'nin kaynağını seçin.
- Web adresinden (URL): WSDL'nin URL'sini girin veya yapıştırın.
- Bilgisayarımdan: Yerel dizininizden bir WSDL dosyası yükleyin. Bağımlılıklar varsa birden fazla dosya yükleyebilirsiniz.
Ad API proxy'sinin adı.
Temel yol API proxy'nizin http(s)://[ana makine] adresinden sonraki URI parçası. Edge, gelen istek mesajlarını eşleştirmek ve uygun API proxy'sine yönlendirmek için temel yol URI'sini kullanır.
Not: Apigee'nin API sürümlendirmeyle ilgili önerileri için Web API Design: The Missing Link (Web API Tasarımı: Eksik Halka) e-kitabındaki Sürümlendirme bölümüne bakın.
Temel yolun ardından ek kaynak URL'leri gelir. İstemcilerin API proxy'nizi çağırmak için kullanacağı tam URL yapısı aşağıda verilmiştir:
https://[host]/base_path/conditional_flow_pathNot: Temel yol benzersiz olmalıdır. Daha sonra bu proxy'yi düzenleyip temel yolunu başka bir API proxy'siyle aynı olacak şekilde ayarlarsanız bu API proxy'si, kaydettiğinizde otomatik olarak dağıtımdan kaldırılır. Yeniden dağıtmadan önce temel yolu düzenlemeniz gerekir.
Temel yollarda joker karakter kullanma
Proxy'lerinizi geleceğe hazır hale getirmek için API proxy temel yollarında bir veya daha fazla
/*/joker karakteri kullanabilirsiniz. Örneğin,/team/*/memberstemel yolu, istemcilerin yeni ekipleri desteklemek için yeni API proxy'leri oluşturmanıza gerek kalmadanhttps://[host]/team/blue/membersvehttps://[host]/team/green/membersçağrılarına izin verir. /**/ karakter dizisinin desteklenmediğini unutmayın.Not: API proxy ana yolu, Ana Yol alanındaki içeriği açıkça düzenlemediğiniz sürece varsayılan olarak Ad alanı için belirtilen değere (tümüyle küçük harflere dönüştürülmüş) ayarlanır.
Açıklama (İsteğe bağlı) API'nin açıklaması. - İleri'yi tıklayın.
- Sihirbazın Ortak politikalar sayfasında aşağıdakileri yapılandırın:
- Güvenlik yetkilendirme şartları. Güvenlik ekleme başlıklı makaleyi inceleyin.
- Merkezler arası kaynak paylaşımı (CORS) desteği. CORS desteği ekleme başlıklı makaleyi inceleyin.
- Arka uç hizmetinizi yüksek trafikten korumak için kotalar. Kotalar başlıklı makaleyi inceleyin. (Geçiş yetkilendirmesi seçiliyse kullanılamaz.)
- Para kazanma özelliğini etkinleştirmiş kuruluşlar için para kazanma sınırı yaptırımı. API proxy'lerine para kazanma sınırlarını uygulama başlıklı makaleyi inceleyin.
- WSDL sayfasında Geçiş SOAP API proxy türünü seçin.
- Kullanmak istediğiniz işlem grubunu belirtmek için açılır menüden bir Bağlantı Noktası Türü seçin. WSDL'de bağlantı noktası türü öğeleri, bir web hizmetinde çağırabileceğiniz işlemleri tanımlar.
- İleri'yi tıklayın.
- Sihirbazın Sanal ana makineler sayfasında, API proxy'sinin dağıtıldığında bağlanacağı sanal ana makineleri seçin. Daha fazla bilgi için Sanal ana makineler hakkında başlıklı makaleyi inceleyin.
- Dağıtım ortamlarını seçin ve Oluştur ve dağıt'ı tıklayın
Yeni API proxy'niz oluşturulur ve seçilen ortama dağıtılır. - API proxy'sinin ayrıntılar sayfasını görüntülemek için Proxy'yi düzenle'yi tıklayın.
Klasik Edge (Private Cloud)
Klasik Edge kullanıcı arayüzünü kullanarak SOAP tabanlı bir hizmete geçiş proxy'si oluşturmak için:
http://ms-ip:9000adresinde oturum açın. ms-ip, Yönetim Sunucusu düğümünün IP adresi veya DNS adıdır.- Üst gezinme çubuğunda API'ler > API Proxy'leri'ni seçin.
- + API Proxy'sini tıklayın.
- Proxy Oluştur sihirbazında SOAP hizmetini seçin.
- İleri'yi tıklayın.
- Ayrıntılar sayfasında aşağıdaki seçimleri yapın. Bir WSDL seçtikten sonra Doğrula'yı tıklamanız gerekir.
Bu alanda bunu yap WSDL WSDL'nin kaynağını seçin.
- URL: Kullanmak istediğiniz WSDL'nin URL'sini girin.
- Dosya: Dosya sisteminizde bir WSDL dosyası seçin. Ek bağımlı dosyaların olduğu durumlarda bunların tümünü seçebilirsiniz.
- Örnek URL: Herkese açık web hizmetleri için WSDL listesinden seçim yapın. Bunlar, Edge'in SOAP/API proxy özelliklerini denemek için kullanışlıdır.
Proxy Adı Bu, oluşturduğunuz proxy'nin adıdır.
Proxy Ana Yolu Proxy temel yolu, bu API proxy'si tarafından sunulan API'yi benzersiz bir şekilde tanımlayan bir URI parçasıdır. API Hizmetleri, gelen istek mesajlarını eşleştirmek ve uygun API proxy'sine yönlendirmek için Temel Yol URI'sini kullanır. (Temel Yol, API'nin alanına eklenir. Alan, kuruluş adınıza ve API proxy'sinin dağıtıldığı ortama göre otomatik olarak oluşturulur.) Proje adına bir sürüm numarası (ör. /v1/delayedstockquote) eklemek en iyi uygulamadır. Bu, API'nizin tüketici uygulamaları tarafından nasıl çağrılacağını belirler.Not: Proxy Ana Yolu, Proxy Adı için belirtilen değere varsayılan olarak ayarlanır. Proxy Ana Yolu alanındaki içeriği açıkça düzenlemediğiniz sürece bu değer tümüyle küçük harflere dönüştürülür.
Açıklama Proxy'nin kısa bir açıklaması. - İleri'yi tıklayın.
- WSDL sayfasında Geçiş SOAP API proxy türünü seçin.
Not: Her WSDL işleminin ve buna karşılık gelen SOAP yayının listelendiği bir tablo gösterilir. Bu, arka uç SOAP hizmetine "iletilen" yüktür.
- Bağlantı noktası türü sütunundan kullanmak istediğiniz işlem grubunu seçin. WSDL'de bağlantı noktası türü öğeleri, bir web hizmetinde çağırabileceğiniz işlemleri tanımlar.
- Güvenlik eklemek, sanal ana makineleri ve dağıtım ortamını seçmek için sihirbazın geri kalanını tıklayın.
- Derleme sayfasında Derle ve Yayınla'yı tıklayın. Edge, WSDL'ye göre yeni API proxy'sini oluşturur ve dağıtır.
Nihai proxy hakkında
Edge bir geçiş proxy'si oluşturduğunda, ortaya çıkan proxy aslında verileri dönüştürme, değişkenleri ayıklayıp ayarlama, iletileri değiştirme ve daha fazlasıyla ilgili politikaları içeren karmaşık bir akıştır. Geçiş proxy'sini oluşturduktan sonra, API yönetim kullanıcı arayüzünün Geliştirme görünümünde ortaya çıkan akışa göz atın. Burada, hangi politikaların eklendiğini tam olarak görebilirsiniz.
Örneğin, aşağıdaki şekilde bir geçiş proxy'sinin Hedef Bitiş Noktası Ön Akış bölümü gösterilmektedir. İstek tarafında, hedef URL'yi ayarlamak için bir AssignMessage politikası kullanılır. Yanıt tarafında, politikalar yanıtı XML'den JSON'a dönüştürmek, yanıtın SOAP gövdesini bir değişkene ayıklamak ve yanıt mesajını ayarlamak için yürütülür. Bu politikalar (ve diğerleri) proxy'yi oluşturduğunuzda otomatik olarak eklenir.
Edge'de barındırılan WSDL: Bu tür bir proxy için oluşturulan Edge'de barındırılan WSDL'yi görmek isterseniz http(s)://[proxy_domain]/[proxy_base_path]?wsdl adresine gidin.
Gelişmiş SOAP'tan REST'e proxy geliştirme
Önceki bölümlerde, Edge'deki API proxy sihirbazı kullanılarak SOAP'tan REST API proxy'sine geçiş işlemi ele alınmıştır. Ancak SOAP'tan REST'e dönüşüm üzerinde daha ayrıntılı kontrol sahibi olmak istiyorsanız sihirbaz tarafından sağlanan otomasyonu atlayabilir ve istediğiniz davranışı elde etmek için politikaları manuel olarak ekleyerek ve yapılandırarak bir proxy oluşturabilirsiniz. Daha fazla bilgi için Eğitim: Apigee Edge'de SOAP'tan REST API proxy'sine manuel yapılandırma başlıklı makaleyi inceleyin.