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

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

Politikaları ve kaynakları, birden fazla API proxy'sinden ve hatta diğer paylaşılan akışlardan yararlanabileceğiniz paylaşılan akışta birleştirebilirsiniz. Paylaşılan bir akışta proxy gibi olsa da uç nokta yoktur. Yalnızca paylaşılan akışın kendisiyle aynı kuruluşta olan bir API proxy'sinden veya paylaşılan akıştan kullanılabilir.

Paylaşılan bir akış, birden çok yerde kullanılabilen tek bir yerde işlev yakalayarak tutarlılığı sağlamanıza, geliştirme süresini kısaltmanıza ve kodu daha kolay yönetmenize yardımcı olur.

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

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

FlowCall politikasını kullanarak paylaşılan bir akışı çağırabilirsiniz. Ayrıca akış kancasına paylaşılan akış ekleyerek, paylaşılan akışın bir proxy veya hedef isteğinden önce ya da bir proxy veya hedef yanıttan sonra yürütülmesini sağlayabilirsiniz.

FlowDescription politikası hakkında referans için FlowCall politikası'na bakın. Akış kancaları hakkında daha fazla bilgi için Akış kancası kullanarak paylaşılan akış ekleme bölümüne bakın.

Örneğin, birden fazla yerde kullanılan veya kuruluşunuzdaki API'lerde standartlaştırılması gereken işlev alanlarınızın olduğunu düşünün. Her kategori için aşağıdakiler gibi ortak bir akışınız olabilir:

  • güvenlik için de geçerlidir.
  • logging (Günlük kaydı) özelliğini gönderin.
  • XML ve JSON mesaj biçimleri arasında dönüşüm yapmak için uyumlulaştırma.

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

Ortak bir akış geliştirme

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

Paylaşılan bir akış geliştirmeye ilişkin üst düzey adımlar şunlardır:

  1. Ortak özellikler grubunun ne olması gerektiğini belirleyin.

    Örneğin, ani trafik artışlarını önlemek gibi trafik yönetimi özelliklerini birleştirmek isteyebilirsiniz. Bu şekilde, iş kolu mantığını uygulayanların iş akışının dışında yapılandırmalarını yönetebilirsiniz.

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

    Paylaşılan akış, bir dizi koşullu adımdır. Yani bir API geliştirmek, API proxy'si geliştirmeye benzer. Proxy'ye dahil edebileceğiniz politikaları ve kaynakları ekleyebilirsiniz.

    Örneğin, trafik yönetimi desteğinizin bir parçası olarak aşağıdaki örnekte olduğu gibi, saniyede yalnızca 30 isteğe izin vermek için bir Spike Arrest 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ı adım olarak ekleyebilirsiniz. Politika, paylaşılan akışı çağıran her API proxy'si 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 edinmek için Edge kullanıcı arayüzünde paylaşılan akış oluşturma bölümüne bakın.

    API proxy'lerinde olduğu gibi, paylaşılan akış kaynağı 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 API Proxy'sini içe aktarma bölümüne bakın). Aşağıda, paylaşılan bir akışın Management API ile 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. Proxy'leri veya paylaşılan akışları tüketecek şekilde dağıtmadan önce paylaşılan akışı ortama dağıtın. Paylaşılan akışı, API proxy'si dağıttığınız şekilde dağıtırsınız. (Daha fazla bilgi için Dağıtıma genel bakış sayfasını inceleyin.)

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

    Paylaşılan bir akışı aşağıdaki gibi bir Management API çağrısıyla 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
    

    Şu anda dağıtılmış olan bir paylaşılan akışı da kapalı kalma süresi olmadan değiştirebilirsiniz. (Bu, API proxy'lerine çok benzer. Daha fazla bilgi için Yönetim API'sini kullanarak API proxy'lerini dağıtma başlıklı makaleyi inceleyin.) Management API'yi kullanan istek formu şöyledir:

    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. Veri tüketen API proxy'sini geliştirerek bu API'nin, paylaşılan akışı kendi akışının bir parçası olarak çağırabilmesini sağlayın.

    Bir API proxy'sinden, Flow anlamı politikası ile paylaşılan bir akışa çağrı yaparsınız. (Paylaşılan akışı, Akış kancası kullanarak paylaşılan akış ekleme bölümünde açıklandığı gibi, bir akış kancası kullanarak da proxy'ye ekleyebilirsiniz.) API proxy'si oluşturmayla ilgili giriş eğitimi kılavuzu için İlk API proxy'nizi oluşturma başlıklı makaleye bakın.

    Paylaşılan bir akışı kullanmak için proxy'ye veya onu kullanacak paylaşılan akışa bir FlowCall politikası eklersiniz. Başka bir hizmeti çağırdığınız Hizmet Çağrısı politikası gibi, bir FlowCall de paylaşılan akışı çağırır. Kullanan API proxy'si, paylaşılan akıştan sonra ve paylaşılan akışla aynı ortama dağıtılmalıdır. Akışa yapılan bir çağrıyı FlowCall politikasını kullanarak test etmek istediğinizde, paylaşılan akışın etkin durumda olması gerekir.

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

    <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 paylaşılan akıştan paylaşılan akış çağırma bölümüne bakın

  5. Paylaşılan akışı kullanmaya başlamak için kullanan API proxy'sini dağıtın. (Genel olarak dağıtımla ilgili daha fazla bilgi için Dağıtımı anlama sayfasını inceleyin.)
  6. API proxy'sinde yaptığınız gibi izleyerek yinelemeli bir şekilde geliştirin.

    API proxy'sinde olduğu gibi, istediğiniz mantığı elde edene kadar yinelemeli bir şekilde ç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ıp proxy'yi izlersiniz.

    İzleyeceğiniz adımlar aşağıda açıklanmıştır:

    1. Hem paylaşılan akışın hem de onu bir FlowCall politikasıyla çağıran API proxy'sinin 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'sindeki bir proxy uç noktasına istek gönderin. Uç noktadan gelen akış, paylaşılan akışa çağrı yapan FlowCall politikasını içermelidir.
    4. İzleme sekmesinde, API proxy'sinden paylaşılan akışa akışı inceleyin.

      İzlemede, paylaşılan akışın gri kutu içine alınmış bir adım veya politika grubu olarak gösterildiğine dikkat edin. FlowCall politikalarını temsil eden simgeler, paylaşılan akışların öncesinde yer alır. (İzleme hakkında daha fazla bilgi için İzleme aracını kullanma sayfasını inceleyin.)

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

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

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

    Edge

    Edge kullanıcı arayüzünü kullanarak Paylaşılan Akışlar sayfasına 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ışlarda kullanılabilecektir. Bu kuruluşun dışından kullanılamayacak.

    3. Sol gezinme çubuğunda Geliştirme > 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 üzerinde oturum açın. Burada 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ışlarda kullanılabilecektir. Bu kuruluşun dışından kullanılamayacak.

    3. Üst gezinme çubuğunda API'ler > Paylaşılan Akışlar'ı seçin.
  2. Yeni bir paylaşılan akış eklemeye başlamak için + Paylaşılan Akış düğmesini tıklayın.
  3. Paylaşılan Akış Oluşturun sayfasında, yeni akışı nasıl oluşturmak istediğinizi seçin:
    • Sıfırdan yeni bir akış oluşturun. Politikaları ve kaynakları akışta adımlar halinde yapılandırabilirsiniz.
      1. Paylaşılan Akışı Boşalt'ı seçin.
      2. Ad değeri girin. Bu, API proxy'leri ve diğer paylaşılan akışların bu paylaşılan akışa referans vermek için kullandığı ad olacaktır. Ad, akışı tüketen geliştiriciler için açıklayıcı olmalıdır.
      3. Akışın ne yaptığı hakkında 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 test için paylaşılan akışı dağıtın.

      6. Yeni paylaşılan akışın oluşturulup seçtiğiniz ortamlara dağıtılması için Derleme ve Dağıt'ı tıklayın. Ortam seçmezseniz paylaşılan akış oluşturulur ancak dağıtılmaz.

    • Bir akış paketi yükleyerek mevcut kaynaklardan paylaşılan akış oluşturun.
      1. Yeni akışta 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, paylaşılan bir akışı Edge kullanıcı arayüzünden indirecekseniz akış paketini içeren bir .zip dosyanız olur.

      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. Paylaşılan Akış Adı kutusuna, içe aktarılan akış için bir ad girin. Bu, API proxy'leri ve diğer paylaşılan akışların bu paylaşılan akışa referans vermek için kullandığı ad olacaktır. Ad, akışı tüketen 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 bir akış çağırma

Flow anlamı politikasını kullanarak bir proxy'den veya başka bir paylaşılan akıştan paylaşılan bir akışı ç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. Gezgin'de, Politikalar'ın yanındaki + düğmesini tıklayın.
  3. Politika listesinde, Uzantı'nın altında, Flow anlamı'nı 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 FlowCall politikasını, çağrının yapılmasını istediğiniz proxy'ye ekleyin.

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

API proxy'lerini birbirine bağlama