Yeniden kullanılabilir paylaşılan akışlar

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

Politikaları ve kaynakları bir paylaşılan akışta birleştirebilirsiniz. Bu akışta, birden fazla API proxy'sinden ve hatta diğer paylaşılan akışlardan yararlanabilirsiniz. Proxy gibi olsa da paylaşılan bir akışın uç noktası yoktur. Yalnızca ortak akışla aynı kuruluştaki bir API proxy'sinden veya ortak akıştan kullanılabilir.

Ortak akış, birden fazla yerde faydalı olan işlevleri tek bir yerde yakalayarak tutarlılık sağlamanıza, geliştirme süresini kısaltmanıza ve kodu daha kolay yönetmenize yardımcı olur.

Aşağıdaki videoda, Edge kullanıcı arayüzünde paylaşılan bir akışın nasıl oluşturulacağı ve izleneceği gösterilmektedir.

Aşağıdaki 5 dakikalık videoda, Klasik Edge kullanıcı arayüzünde (yalnızca Özel Bulut için Edge) paylaşılan bir akışın nasıl oluşturulacağı ve izleneceği gösterilmektedir.

Akış Açıklaması Politikası'nı kullanarak paylaşılan bir akışı çağırabilirsiniz. Ayrıca, paylaşılan bir akışı bir akış kancasına ekleyerek paylaşılan akışın bir proxy veya hedef istek öncesinde ya da bir proxy veya hedef yanıtından sonra yürütülmesini sağlayabilirsiniz.

Akış Çağrı Politikası hakkında referans için Akış Çağrı politikası'na bakın. Akış kancaları hakkında daha fazla bilgi için Akış kancası kullanarak paylaşılan akış ekleme başlıklı makaleyi inceleyin.

Örneğin, birden fazla yerde kullanılan veya kuruluşunuzdaki API'ler arasında standartlaştırılması gereken işlev alanları olduğunu varsayalım. Her kategori için aşağıdakiler gibi paylaşılan bir akış oluşturabilirsiniz:

  • OAuth ve API anahtarı doğrulaması kullanan yetkilendirme kodu ile tehdit koruma kodu içeren security.
  • logging (standart hata mesajları oluşturmak için).
  • XML ile JSON mesaj biçimleri arasında dönüştürme için arabuluculuk.

Aşağıdaki çizimde iki API proxy'si, gelen kullanıcı isteklerinin kimliğini doğrulamak için paylaşılan bir akışa (FashCall politikasıyla birlikte) çağrı yapar. AuthSharedFlow, proxy'lerden gelen istekleri destekleyebilmek için proxy'lerden önce kuruluşa ayrı olarak dağıtılmıştır. Paylaşılan akış, kapsamlı şirket politikalarından sorumlu bir ekip tarafından geliştirilip yönetilebilir ve ardından daha özel uygulamalar oluşturan iş kolu ekipleri tarafından proxy'ler içinde tüketilebilir.

Paylaşılan bir akış geliştirme

Paylaşılan bir akış geliştirirken her zaman bir API proxy'sine gönderilen çağrılarla test etmeniz gerekir. Yani bir API proxy'si gibi doğrudan paylaşılan akışa istek gönderemezsiniz. Bunun yerine istekleri, paylaşılan akışa çağrı yapan bir API proxy'sine gönderirsiniz.

Paylaşılan akış geliştirmeyle ilgili üst düzey adımlar aşağıda verilmiştir:

  1. Ortak özellik grubu'nun ne olması gerektiğini belirleyin.

    Örneğin, trafik ani artışlarını engelleme dahil olmak üzere trafik yönetimi özelliklerini birlikte kullanmak isteyebilirsiniz. Böylece, iş kolu mantığını uygulayan kullanıcıların iş akışı dışında yapılandırmalarını yönetebilirsiniz.

  2. API proxy'si geliştirirken yaptığınız gibi politikaları ve destekleyici kaynakları uygulayarak ortak bir akış geliştirin.

    Paylaşılan akış, koşullu adımlardan oluşan bir ardışık düzendir. Bu nedenle, bir SOAP hizmetini geliştirmek, API proxy'si geliştirmeye benzer. Bir proxy'ye ekleyebileceğiniz politikaları ve kaynakları ekleyebilirsiniz.

    Örneğin, trafik yönetimi desteğiniz kapsamında, aşağıdaki örnekte gösterildiği gibi saniye başına yalnızca 30 isteğe izin verecek bir ani artış durdurma politikası uygulayabilirsiniz:

    <SpikeArrest async="false" continueOnError="false" enabled="true" name="Spike-Arrest">
    <DisplayName>Spike Arrest</DisplayName>
    <Properties/>
    <Identifier ref="request.header.some-header-name"/>
    <MessageWeight ref="request.header.weight"/>
    <Rate>30ps</Rate>
</SpikeArrest>

    Ardından, trafik yönetimi için paylaşılan bir akışa Spike Arrest politikasını bir adım olarak ekleyebilirsiniz. Politika, paylaşılan akışı çağıran tüm API proxy'leri için yürütülür.

    <SharedFlow name="default">
    <Step>
        <Name>Spike-Arrest</Name>
    </Step>
</SharedFlow>

    Yönetim konsolunda paylaşılan bir akışın nasıl başlatılacağı hakkında bilgi için Edge kullanıcı arayüzünde paylaşılan bir akış oluşturma bölümüne bakın.

    API proxy'lerinde olduğu gibi, paylaşılan akış kaynak yapılarınızı içeren bir ZIP dosyasını içe aktarabilirsiniz (proxy'leri içe aktarma hakkında daha fazla bilgi için Yeni bir API proxy'si içe aktarma başlıklı makaleyi inceleyin). Aşağıda, yönetim API'si ile ortak bir akışın nasıl içe aktarılacağı gösterilmektedir:

    curl -X POST -F "file=@/path/to/zip/file.zip" \ 'https://api.enterprise.apigee.com/v1/o/{org_name}/sharedflows?action=import&name=shared-flow-name' \
-u email:password
  3. Ortamı tüketecek proxy'ler veya paylaşılan akışlar dağıtmadan önce paylaşılan akışı ortama dağıtın. Ortak akışı, API proxy'si dağıttığınız şekilde dağıtırsınız. (Daha fazla bilgi için Dağıtıma genel bakış bölümüne bakın.)

    Paylaşılan akış, API proxy'leri ve bu akışları kullanan diğer paylaşılan akışlarla aynı kuruluşta olmalı ve aynı ortama dağıtılmalıdır. Paylaşılan akışın proxy'lerden önce dağıtılması proxy'nin dağıtım sırasında paylaşılan akışa olan bağımlılığını çözmeyi mümkün kılar.

    Aşağıdaki gibi bir management API çağrısıyla paylaşılan bir akış dağıtabilirsiniz:

    curl -X POST --header "Content-Type: application/octet-stream" \
https://api.enterprise.apigee.com/v1/o/{org_name}/e/{env_name}/sharedflows/{shared_flow_name}/revisions/{revision_number}/deployments \
-u email:password

    Ayrıca, dağıtılmış bir paylaşılan akışı kesinti olmadan değiştirebilirsiniz. (Bu, API proxy'lerine çok benzer. Daha fazla bilgi için Yönetim API'sini kullanarak API proxy'leri dağıtma bölümüne bakın. Management API'yi kullanan istek formu aşağıdaki gibidir:

    curl -X POST --header "Content-Type:application/x-www-form-urlencoded" \
https://api.enterprise.apigee.com/v1/o/{org_name}/e/{env_name}/sharedflows/{shared_flow_name}/revisions/{revision_number}/deployments?"override=true" \
-u email:password
  4. Paylaşılan akışı kendi akışı kapsamında çağırabilmesi için API proxy'yi geliştirin.

    API proxy'sinden FlowCallout politikası içeren paylaşılan bir akışı çağırırsınız. (Paylaşılan akışı, Akış kancası kullanarak paylaşılan akış ekleme konusunda açıklandığı gibi, bir akış kancası kullanarak proxy'ye ekleyebilirsiniz.) API proxy'si oluşturmayla ilgili giriş eğitimi için İlk API proxy'nizi oluşturma başlıklı makaleyi inceleyin.

    Paylaşılan bir akışı kullanmak için proxy'ye veya paylaşılan akışa bu akışı kullanacak bir FlowDraft politikası eklemeniz gerekir. Başka bir hizmeti çağırdığınız Hizmet Açıklaması politikası gibi, FlowCallout da paylaşılan akışı çağırır. API proxy'si, paylaşılan akıştan sonra ve paylaşılan akışla aynı ortama dağıtılmalıdır. FlowCallout politikasını kullanarak bir çağrıyı test etmek istediğinizde paylaşılan akışın mevcut olması gerekir.

    Aşağıdaki kodda bir FlowDescription politikası traffic-management-shared adlı paylaşılan bir akışı çağırıyor.

    <FlowCallout async="false" continueOnError="false" enabled="true" name="Traffic-Management-Flow-Callout">
    <DisplayName>Traffic Management FlowCallout</DisplayName>
    <Properties/>
    <SharedFlowBundle>traffic-management-shared</SharedFlowBundle>
</FlowCallout>

    Daha fazla bilgi için API proxy'sinden veya ortak akıştan ortak akış çağırma başlıklı makaleyi inceleyin.

  5. Paylaşılan akışı kullanmaya başlamak için API proxy'sini dağıtın. (Genel olarak dağıtım hakkında daha fazla bilgi için Dağıtımı anlama sayfasını inceleyin.)
  6. API proxy'sinde yaptığınız gibi, izleme yaparak iteratif olarak geliştirin.

    API proxy'sinde olduğu gibi, mantığı istediğiniz şekilde elde edene kadar iteratif olarak çağırıp izleyerek paylaşılan bir akış geliştirirsiniz. Bu durumda, paylaşılan akış kendi başına çalışmadığı için bir proxy uç noktası çağırır ve proxy'yi izlersiniz.

    Şu adımları uygulayabilirsiniz:

    1. Hem paylaşılan akışın hem de FlowCallout politikasıyla çağıran API proxy'nin aynı kuruluşta olduğundan ve aynı ortama dağıtıldığından emin olun.
    2. API proxy'sinin İzleme sekmesinde API proxy'sini izlemeye başlayın.
    3. API proxy'sinde bir proxy uç noktasına istek gönderin. Uç noktadan gelen akış, paylaşılan akışa çağrı yapan FlowCaption politikasını içermelidir.
    4. Trace (İzleme) sekmesinde, API proxy'sinden paylaşılan akışa olan akışı inceleyin.

      İzlemede, paylaşılan akış gri bir kutuya yerleştirilmiş bir dizi adım veya politika olarak temsil edilir. Paylaşılan akışlardan önce akış metni politikalarını temsil eden simgeler. (İzleme hakkında daha fazla bilgi için İzleme aracını kullanma başlıklı makaleyi inceleyin.)

Edge kullanıcı arayüzünde paylaşılan akış oluşturma

Ortak bir akış oluşturmak için Apigee Edge kullanıcı arayüzünü kullandığınızda sıfırdan veya mevcut akış kaynaklarını akış paketi .zip dosyası olarak içe aktararak akış oluşturabilirsiniz.

  1. Aşağıda açıklandığı şekilde Paylaşılan Akışlar sayfasına erişin. Ortak Akışlar sayfasında, kuruluştaki ortak akışların listesini görüntüleyebilir ve listedeki akışları düzenleyebilir veya silebilirsiniz.

    Edge

    Paylaşılan Akışlar sayfasına Edge kullanıcı arayüzünü kullanarak erişmek için:

    1. apigee.com/edge adresinde oturum açın.
    2. Paylaşılan akışınızı içeren kuruluşu seçin. Kuruluşlarınız arasında geçiş yapma başlıklı makaleyi inceleyin.

      Paylaşılan akış, bu kuruluştan bir ortama dağıtılan tüm API proxy'leri ve paylaşılan akışlar tarafından kullanılabilir. Bu kuruluşun dışından kullanılamaz.

    3. Sol gezinme çubuğunda Geliştir > Paylaşılan Akışlar'ı seçin.

    Klasik Edge (Private Cloud)

    Klasik Edge kullanıcı arayüzünü kullanarak Paylaşılan Akışlar sayfasına erişmek için:

    1. http://ms-ip:9000 adresinde oturum açın. ms-ip, Yönetim Sunucusu düğümünün IP adresi veya DNS adıdır.
    2. Paylaşılan akışınızı içeren kuruluşu seçin. Kuruluşlarınız arasında geçiş yapma başlıklı makaleyi inceleyin.

      Paylaşılan akış, bu kuruluştan bir ortama dağıtılan tüm API proxy'leri ve paylaşılan akışlar için kullanılabilecektir. Bu kuruluşun dışından kullanılamaz.

    3. Üst gezinme çubuğunda API'ler > Ortak Akışlar'ı seçin.
  2. Yeni bir paylaşılan akış eklemeye başlamak için + Paylaşılan Akış düğmesini tıklayın.
  3. Ortak Akış Oluştur sayfasında yeni akışı nasıl oluşturmak istediğinizi seçin:
    • Sıfırdan yeni bir akış oluşturun. Politikaları ve kaynakları akıştaki adımlar olarak yapılandırabilirsiniz.
      1. Paylaşılan Akışı Boşalt'ı seçin.
      2. Bir ad değeri girin. Bu, API proxy'lerinin ve diğer paylaşılan akışların bu paylaşılan akışa referans vermek için kullanacağı ad olacaktır. Ad, akışı kullanan geliştiriciler için açıklayıcı olmalıdır.
      3. Akışla ilgili daha fazla bilgi sağlamak için bir açıklama girin.
      4. İleri'yi tıklayın.
      5. İsteğe bağlı olarak, yeni akışın dağıtılmasını istediğiniz ortamları seçin.

        Örneğin, test ortamına dağıtılan API proxy'lerinden paylaşılan akışı test edecekseniz paylaşılan akışı test ortamına dağıtın.

      6. Yeni ortak akışın oluşturulup seçtiğiniz ortamlara dağıtılması için Oluştur ve Dağıt'ı tıklayın. Hiçbir ortam seçmediyseniz paylaşılan akış oluşturulur ancak dağıtılmaz.

    • Akış paketi yükleyerek mevcut kaynaklardan paylaşılan akış oluşturun.
      1. Yeni akışta olmasını istediğiniz yapıları içeren bir .zip dosyası belirtmek için Paylaşılan Akış Paketi'ni seçin.

        Paylaşılan akış paketi, paylaşılan bir akışın kaynak yapılarını içerir. Örneğin, Edge kullanıcı arayüzünden paylaşılan bir akışı indirirseniz akış paketini içeren bir .zip dosyası elde edersiniz.

      2. İleri'yi tıklayın.
      3. İçe aktarmak istediğiniz paylaşılan akış kaynaklarını içeren .zip dosyasına göz atmak için Dosya Seç'i tıklayın.
      4. Ortak Akış Adı kutusuna içe aktarılan akış için bir ad girin. Bu, API proxy'lerinin ve diğer paylaşılan akışların bu paylaşılan akışa referans vermek için kullandığı ad olacaktır. Ad, akışı kullanan geliştiriciler için açıklayıcı olmalıdır.
      5. İleri'yi tıklayın.
      6. İçe aktardığınız kaynaklardan yeni akışı oluşturmak için Oluştur'u tıklayın.

API proxy'sinden veya paylaşılan akıştan paylaşılan akış çağırma

FlowCallout politikasını kullanarak paylaşılan bir akışı proxy'den veya başka bir paylaşılan akıştan çağırabilirsiniz.

  1. Edge kullanıcı arayüzünde, başka bir paylaşılan akışı çağırmak istediğiniz proxy'yi veya paylaşılan akışı bulun.
  2. Gezinme menüsünde Politikalar'ın yanındaki + düğmesini tıklayın.
  3. Politika listesinde, Uzantı altında FlowCallout'u tıklayın.
  4. Görünen adı ve adı (benzersiz tanımlayıcı) girin, ardından bu politikanın çağıracağı paylaşılan akışı seçin.
  5. Ekle'yi tıklayın.
  6. Yeni Akış Çağrı politikasını, aramanın yapılmasını istediğiniz proxy'ye ekleyin.

Aşağıdaki kaynakları da incelemenizi öneririz:

API proxy'lerini birbirine bağlama