SOAP hizmetini API proxy'si olarak kullanıma sunma

Apigee Edge belgelerini görüntülüyorsunuz.
Apigee X belgelerini görüntüleyin.

Bu makalede, SOAP tabanlı web hizmetleri için API proxy'lerinin nasıl oluşturulacağı açıklanmaktadır. Edge'de iki tür SOAP proxy'si oluşturabilirsiniz. Biri, arka uç SOAP hizmetine bir RESTful arayüzü oluşturur, diğeri de arka tarafa SOAP mesajının bir "geçişini" gerçekleştirir. Her iki teknik de bu konuda açıklanmaktadır.

Bu videoda, API proxy sihirbazını kullanarak bir SOAP hizmetinin REST hizmetine dönüştürülmesi için uçtan uca bir demo sunulmaktadır. Ancak SOAP-REST 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-REST API proxy'si için manuel oluşturma bölümüne bakın.

SOAP tabanlı bir hizmete RESTful API proxy'si oluşturma

Bu bölümde, proxy oluşturma sihirbazındaki REST to SOAP-REST bağlantısıyla RESTful SOAP API proxy'sinin nasıl oluşturulacağı açıklanmaktadır.

Genel bakış

REST'ten SOAP'a ve REST'e seçeneği, WSDL'yi işler ve bir RESTful API proxy'si oluşturur. Edge, WSDL'den hizmetin desteklenen işlemlerini, giriş parametrelerini vb. belirler. Edge, her işlem için hangi HTTP yönteminin kullanılacağını "tahmin eder". Edge, işlemleri genellikle önbelleğe alınabilir avantajına sahip GET isteklerine çevirir. Edge, arka uç hedef uç noktasını da ayarlar. Bu uç nokta, SOAP işlemine göre değişebilir.

Edge, bu tür bir proxy için otomatik olarak API dokümanları oluşturmak amacıyla kullanabileceğiniz bir OpenAPI Şartnamesi oluşturur.

Temel adımlar

Edge

Edge kullanıcı arayüzünü kullanarak SOAP tabanlı bir hizmete RESTful API proxy'si oluşturmak için:

  1. Apigee.com/edge sayfasında oturum açın.
  2. Sol gezinme çubuğunda Geliştirme > API Proxy'leri seçeneğini belirleyin.
  3. +Proxy'yi tıklayın.
  4. SOAP hizmeti'ni tıklayın.
  5. Proxy ayrıntıları sayfasında, WSDL dosyasını sağlayın.
    Alan Açıklama
    WSDL dosyası sağlayın

    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.
  6. WSDL'yi doğrulamak için Doğrula'yı tıklayın.
  7. 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)://[host] adresinden sonra görünen URI parçası. Edge, gelen istek mesajlarını eşleştirmek ve doğru API proxy'sine yönlendirmek için temel yol URI'sini kullanır.

    NOT: API proxy'si temel yolu, varsayılan olarak tamamen küçük harfe dönüştürülen Name alanı için belirtilen değere ayarlanır.

    Temel yolu izleyen ek kaynak URL'leri aşağıda verilmiştir. İstemcilerin API proxy'nizi çağırmak için kullanacağı tam URL yapısı aşağıda verilmiştir:

    https://[host]/base_path/conditional_flow_path

    NOT: 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üzenler ve temel yolu başka bir API proxy'sinin temel yoluyla aynı değere ayarlarsanız Edge, API proxy'sini kaydettiğinizde otomatik olarak dağıtımdan kaldırır. API proxy'sini yeniden dağıtabilmek için temel yolu benzersiz olacak şekilde düzenlemeniz gerekir.

    Temel yollarda joker karakterler kullanma

    API proxy'nizin temel yollarında API proxy'lerinizi geleceğe hazırlamak için bir veya daha fazla /*/ joker karakteri kullanın. Örneğin, /team/*/members gibi bir temel yol, istemcilerin yeni ekipleri desteklemek için yeni API proxy'leri oluşturmanıza gerek kalmadan https://[host]/team/blue/members ve https://[host]/team/green/members hizmetlerini çağırmasına olanak tanır. /**/ özelliğinin desteklenmediğini unutmayın.
    Açıklama (İsteğe bağlı) API'nin açıklaması.
  8. İleri'yi tıklayın.
  9. Sihirbazın Genel politikalar sayfasında aşağıdakileri yapılandırın:
    • Güvenlik: Yetkilendirme bölümündeki güvenlik yetkilendirmesi gereksinimleri. Güvenlik ekleme başlıklı makaleye bakın.
    • Güvenlik: Tarayıcı altında kaynaklar arası kaynak paylaşımı (CORS) desteği. CORS desteği ekleme başlıklı makaleye bakın.
    • Kota bölümünde arka uç hizmetinizi yüksek trafiğe karşı koruyacak kotalar. Kotalar bölümüne bakın. (Başarılı geçiş seçiliyse kullanılamaz.)
  10. WSDL işlemleri sayfasında, REST'ten SOAP'a ve REST'e API proxy türünü seçin.

    Edge'in WSDL dosyasında "keşfettiği" işlemleri listeleyen bir tablo görüntülenir. API proxy'nize dahil etmek istediğiniz işlemleri seçip yapılandırabilirsiniz. Tablo aşağıdaki şekilde gösterilmektedir.

  11. 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.
  12. Bir işlemin REST API Yolunu isteğe bağlı olarak değiştirin. Yol, API proxy URL'sinde kaynak adı olarak kullanılır.
  13. İsteğe bağlı olarak, işlemle ilişkili Fiil'i (HTTP yöntemi) değiştirin.
  14. İleri'yi tıklayın.
  15. Sihirbazın Sanal ana makineler sayfasında, API proxy'sinin dağıtılacağı sanal ana makineleri seçin. Daha fazla bilgi için Sanal ana makineler hakkında başlıklı makaleye bakın.
  16. İleri'yi tıklayın.
  17. Dağıtım ortamlarını seçip Oluştur ve dağıt'ı tıklayın
    Yeni API proxy'niz oluşturulur ve seçilen ortama dağıtılır.
  18. 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 RESTful API proxy'si oluşturmak için:

  1. http://ms-ip:9000 sayfasında oturum açın. Burada ms-ip, Yönetim Sunucusu düğümünün IP adresidir veya DNS adıdır.
  2. Üstteki gezinme çubuğunda API'ler > API Proxy'leri seçeneğini belirleyin.
  3. + API Proxy'si seçeneğini tıklayın.
  4. Derleme Proxy'si sihirbazında SOAP hizmetini seçin.
  5. İleri'yi tıklayın.
  6. Ayrıntılar sayfasında bu 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 tümünü seçebilirsiniz.
    • Örnek URL - Herkese açık web hizmetleri için bir 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 Temel Yolu

    API proxy'nizin http(s)://[host] adresinden sonra görünen URI parçası. Edge, gelen istek mesajlarını eşleştirmek ve doğru API proxy'sine yönlendirmek için temel yol URI'sini kullanır.

    Not: API proxy'si temel yolu, varsayılan olarak tamamen küçük harfe dönüştürülen Name alanı için belirtilen değere sahiptir.

    Temel yolu izleyen ek kaynak URL'leri aşağıda verilmiştir. İstemcilerin API proxy'nizi çağırmak için kullanacağı tam URL yapısı aşağıda verilmiştir:

    https://[host]/base_path/conditional_flow_path

    Not: 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üzenler ve temel yolu başka bir API proxy'sinin temel yoluyla aynı değere ayarlarsanız Edge, API proxy'sini kaydettiğinizde otomatik olarak dağıtımdan kaldırır. API proxy'sini yeniden dağıtabilmek için temel yolu benzersiz olacak şekilde düzenlemeniz gerekir.

    Temel yollarda joker karakterler kullanma

    API proxy'nizin temel yollarında API proxy'lerinizi geleceğe hazırlamak için bir veya daha fazla /*/ joker karakteri kullanın. Örneğin, /team/*/members gibi bir temel yol, istemcilerin yeni ekipleri desteklemek için yeni API proxy'leri oluşturmanıza gerek kalmadan https://[host]/team/blue/members ve https://[host]/team/green/members hizmetlerini çağırmasına olanak tanır. /**/ özelliğinin desteklenmediğini unutmayın.
    Açıklama Proxy'nin kısa bir açıklaması.
  7. İleri'yi tıklayın.
  8. WSDL sayfasında REST - SOAP - REST arası API proxy türünü seçin.

    Edge'in WSDL dosyasında "keşfettiği" işlemleri listeleyen bir tablo görüntülenir. API proxy'nize dahil etmek istediğiniz işlemleri seçip yapılandırabilirsiniz. Tablo aşağıdaki şekilde gösterilmektedir.

    WSDL işlemleri sayfasında, API proxy türü REST'ten SOAP'a ve REST'e ayarlanır. Bir tabloda ekleme işlemi içeren bir satır sonuç gösterilir.

  9. Kullanmak istediğiniz işlem grubunu Bağlantı Noktası Türü sütunundan seçin. WSDL'de bağlantı noktası türü öğeleri, bir web hizmetinde çağırabileceğiniz işlemleri tanımlar.
  10. İ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 belirleme konusunda bir "en iyi tahmin"de bulunur. GET istekleri önbelleğe alınabildiğinden genellikle GET tercih edilir.
  11. Bir işlemin REST API yolunu isteğe bağlı olarak değiştirin. Yol, API proxy URL'sinde kaynak adı olarak kullanılır.
  12. Güvenlik eklemek, sanal ana makineler ve dağıtım ortamı eklemek için sihirbazın geri kalanını tıklayın.
  13. Derleme sayfasında Oluştur ve Dağıt'ı tıklayın. Edge, yeni API proxy'sini WSDL'ye göre oluşturup dağıtır.
  14. Yeni API proxy'sinin özet sayfasına gidin. WSDL dosyasında bulunan işlemlere dayalı olarak bir grup kaynağın oluşturulduğunu unutmayın.

    Proxy'nin Genel Bakış sayfasında Kaynaklar listesi yeni API'nin, işlemlerin ve parametrelerin ayrıntılı bir açıklamasını sağlar. Bu temsili API'nin referans dokümanları olarak düşünebilirsiniz. Edge, bu API modeli 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.

Son proxy hakkında

Edge, bir WSDL'ye dayalı bir API proxy'si oluşturduğunda sonuçta ortaya çıkan proxy, aslında verileri dönüştürme, değişkenleri çıkarma ve ayarlama, mesajları değiştirme gibi politikaları içeren karmaşık bir akıştır. WSDL'ye dayalı bir proxy oluşturduktan sonra, API yönetimi kullanıcı arayüzünün Geliştirme görünümünde oluşan akışa göz atın. Burada, tam olarak hangi politikaların eklendiğini görebilirsiniz.

Örneğin, istek URL'sinde hedef URL'yi ayarlamak için bir MessageMessage 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 almak ve yanıt mesajını ayarlamak için yürütülür. Bu politikalar (ve diğer politikalar), proxy oluşturulurken otomatik olarak eklenir.

OpenAPI Özellikleri: Bu proxy için otomatik oluşturulan OpenAPI Spesifikasyonunu görüntülemek için http(s)://[proxy_domain]/[proxy_base_path]/openapi.json adresini ziyaret edin. Bununla birlikte, bir XML şemasının tüm kuralları bir OpenAPI Spesifikasyonunda gösterilemediği için dönüşüm her zaman doğru olmaz.

SOAP tabanlı bir hizmete geçiş proxy'si oluşturma

Bu bölümde, Yeni Proxy Oluştur iletişim kutusundaki Geçiş Proxy'si seçeneğiyle geçiş proxy'sinin nasıl oluşturulacağı açıklanmaktadır.

Genel bakış

Geçiş Proxy seçeneği, bir istekteki SOAP mesajını "dokunulmayan" arka uç hizmetine ileten bir proxy oluşturmanıza olanak tanır. Bu da SOAP tabanlı bir web hizmeti için proxy oluşturmayı çok kolaylaştırır. Arka planda Edge, tüm dönüşümleri ve diğer akış etkinliklerini sizin için otomatik olarak işler. Örneğin, istek JSON biçimindeyse Edge, hizmeti POST'ta yayınlamadan önce doğru ad alanlarına sahip geçerli bir XML SOAP iletisine dönüştürmek için gerekli adımları atar. Benzer şekilde, hizmet XML tabanlı bir SOAP yanıtı döndürdüğünde, Edge bunu istemciye döndürmeden önce JSON'a çevirir. Ayrıca Edge, SOAP işlemine göre değişebilen arka uç hedef uç noktası oluşturur.

Edge, bu tür bir proxy için WSDL'yi barındırır ve proxy'de buna erişmenizi sağlamak için bir akış oluşturur. Edge'de barındırılan bu WSDL'nin adresi olan 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:

  1. Apigee.com/edge sayfasında oturum açın.
  2. Sol gezinme çubuğunda Geliştirme > API Proxy'leri seçeneğini belirleyin.
  3. +Proxy'yi tıklayın.
  4. SOAP hizmeti'ni tıklayın.
  5. 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 doğru API proxy'sine yönlendirmek için temel yol URI'sini kullanır.

    Not: Apigee'nin API sürümü oluşturmayla ilgili önerileri için Web API Design: The Missing Link (Web API Tasarımı: Eksik Bağlantı) e-kitabında Versioning (Sürüm Oluşturma) bölümüne bakın.

    Temel yol, ek kaynak URL'lerinden sonra 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_path

    Not: Temel yol benzersiz olmalıdır. Daha sonra bu proxy'yi düzenler ve temel yolunu başka bir API proxy'siyle aynı olacak şekilde ayarlarsanız bu API proxy'si, kaydedildiğinde otomatik olarak dağıtılmaz. Yeniden dağıtmadan önce temel yolu düzenlemeniz gerekir.

    Temel yollarda joker karakter kullanma

    Proxy'lerinizi geleceğe hazırlamak için API proxy'si temel yollarında bir veya daha fazla /*/ joker karakteri kullanabilirsiniz. Örneğin, /team/*/members gibi bir temel yol, istemcilerin yeni ekipleri desteklemek için yeni API proxy'leri oluşturmanıza gerek kalmadan https://[host]/team/blue/members ve https://[host]/team/green/members hizmetlerini çağırmasına olanak tanır. /**/ öğelerinin desteklenmediğini unutmayın.

    Not: Temel proxy alanındaki içeriği açık bir şekilde düzenlemediğiniz sürece API proxy'sinin temel yolu, Ad alanı için küçük harfle başlayan tüm değerleri varsayılan olarak ayarlar.
    Açıklama (İsteğe bağlı) API'nin açıklaması.
  6. İleri'yi tıklayın.
  7. Sihirbazın Genel politikalar sayfasında aşağıdakileri yapılandırın:
  8. WSDL sayfasında API'nin proxy türü olan Geçiş SOAP'ı seçin.

  9. 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.
  10. İleri'yi tıklayın.
  11. Sihirbazın Sanal ana makineler sayfasında, API proxy'sinin dağıtılacağı sanal ana makineleri seçin. Daha fazla bilgi için Sanal ana makineler hakkında başlıklı makaleye bakın.
  12. Dağıtım ortamlarını seçip Oluştur ve dağıt'ı tıklayın
    Yeni API proxy'niz oluşturulur ve seçilen ortamda dağıtılır.
  13. 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:

  1. http://ms-ip:9000 sayfasında oturum açın. Burada ms-ip, Yönetim Sunucusu düğümünün IP adresidir veya DNS adıdır.
  2. Üstteki gezinme çubuğunda API'ler > API Proxy'leri seçeneğini belirleyin.
  3. + API Proxy'si seçeneğini tıklayın.
  4. Derleme Proxy'si sihirbazında SOAP hizmetini seçin.
  5. İleri'yi tıklayın.
  6. Ayrıntılar sayfasında bu 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 tümünü seçebilirsiniz.
    • Örnek URL - Herkese açık web hizmetleri için bir 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 Temel Yolu Proxy Temel Yolu, bu API proxy'sinin gösterildiği API'yi benzersiz şekilde tanımlayan bir URI parçasıdır. API Hizmetleri, gelen istek mesajlarını eşleştirmek ve doğru API proxy'sine yönlendirmek için Temel Yol URI'sini kullanır. (Temel Yol, kuruluş adınıza ve API proxy'sinin dağıtıldığı ortama göre otomatik olarak oluşturulan API alan adına eklenir.) En iyi uygulama, proje adına bir sürüm numarası eklemektir. Örneğin, /v1/delayedstockquote. Bu, API'nin tüketici uygulamaları tarafından nasıl çağrılacağını belirler.

    Not: Proxy Temel Yolu alanında içeriği açık bir şekilde düzenlemediğiniz sürece Proxy Temel Yolu'nun varsayılan değeri küçük harf olacak şekilde ayarlanır.
    Açıklama Proxy'nin kısa bir açıklaması.

  8. İleri'yi tıklayın.
  9. WSDL sayfasında, Proxy SOAP API proxy türünü seçin.

    Not: Her WSDL işlemini ve ilgili SOAP yükünü listeleyen bir tablo görünür. Bu, arka uç SOAP hizmetine "geçen" yüktür.

    WSDL sayfasında API proxy türü Geçişli SOAP olarak ayarlanır ve GetPoint gibi işlemlerin listesi bağlantı noktası türüne göre düzenlenir.
  10. Kullanmak istediğiniz işlem grubunu Bağlantı Noktası Türü sütunundan seçin. WSDL'de bağlantı noktası türü öğeleri, bir web hizmetinde çağırabileceğiniz işlemleri tanımlar.
  11. Güvenlik eklemek, sanal ana makineler ve dağıtım ortamı eklemek için sihirbazın geri kalanını tıklayın.
  12. Derleme sayfasında Oluştur ve Dağıt'ı tıklayın. Edge, yeni API proxy'sini WSDL'ye göre oluşturup dağıtır.

Son proxy hakkında

Edge bir geçiş proxy'si oluşturduğunda sonuçta ortaya çıkan proxy, verilerin dönüştürülmesi, değişkenlerin alınması ve ayarlanması, mesajların manipüle edilmesi ve daha fazlasıyla ilgili politikaları içeren karmaşık bir akıştır. Geçiş proxy'sini oluşturduktan sonra, API yönetimi kullanıcı arayüzünün Geliştirme görünümünde ortaya çıkan akışa göz atın. Burada, tam olarak hangi politikaların eklendiğini görebilirsiniz.

Örneğin, aşağıdaki şekilde bir geçiş proxy'sinin Hedef Uç Noktası Ön Akışı bölümü gösterilmektedir. Hedef tarafta, hedef URL'yi ayarlamak için bir AtananMesaj 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 almak ve yanıt mesajını ayarlamak için yürütülür. Bu politikalar (ve diğerleri), proxy oluşturduğunuzda otomatik olarak eklenir.

Geliştirme görünümünde, Akış panelinde oklar istekten yanıta, simgeleri ise politikalardan oluşur.

Edge barındırılan WSDL: Bu tür bir proxy için oluşturulan Edge'de barındırılan WSDL'yi görmek için http(s)://[proxy_domain]/[proxy_base_path]?wsdl adresine gidin.

Gelişmiş SOAP-REST proxy geliştirme

Önceki bölümlerde, Edge'de API proxy sihirbazını kullanarak SOAP-REST API proxy'si oluşturma işlemi açıklandı. Ancak SOAP-REST dönüşümü üzerinde daha hassas bir denetim istiyorsanız sihirbaz tarafından sağlanan otomasyonu atlayıp istediğiniz davranışı elde etmek için politikaları manuel olarak ekleyip yapılandırarak bir proxy oluşturabilirsiniz. Daha fazla bilgi için Eğitim: Apigee Edge'de SOAP-REST API proxy'si için manuel oluşturma bölümüne bakın.