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

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

Politikaları ve kaynakları, birden fazla API proxy'sinden ve hatta diğer paylaşılan akışlardan kullanabileceğiniz bir paylaşılan akışta birleştirebilirsiniz. Proxy gibi görünse de paylaşılan akışlarda uç nokta yoktur. Yalnızca paylaşılan akışın kendisiyle aynı kuruluştaki bir API proxy'sinden veya paylaşılan akıştan kullanılabilir.

Paylaşılan akış, birden fazla yerde kullanılabilecek tek bir yere işlev yükleyerek 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 Private Cloud için Edge) paylaşılan akış oluşturma ve izleme işlemleri gösterilmektedir.

Akış çağrısı politikasını kullanarak paylaşılan bir akışı çağırabilirsiniz. Ayrıca, bir 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ıtından sonra yürütülmesini sağlayabilirsiniz.

Akış Çağrısı politikası ile ilgili referans için FlowCallout politikası konusuna 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'ler genelinde standartlaştırılması gereken işlev alanlarına sahip olduğunuzu düşünelim. Her bir kategori için paylaşılan bir akışa sahip olabilirsiniz. Örneğin:

  • OAuth ve API anahtar doğrulaması ile yetkilendirme kodu ve tehdit koruma kodu kullanarak security.
  • Standart hata mesajları oluşturmak için günlük kaydını kullanın.
  • uyumlulaştırma, XML ve JSON mesaj biçimleri arasında dönüşüm sağlar.

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 bulunur (Akış Çağrısı politikası ile). AuthSharedFlow, proxy'lerden önce kuruluşa ayrı olarak dağıtıldığı için proxy'lerden gelen istekleri desteklemek amacıyla kullanılabilir. 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'lerde tüketilebilir.

Paylaşılan akış geliştirme

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

Aşağıda, paylaşılan akış oluşturmaya yönelik üst düzey adımlar verilmiştir:

  1. Paylaşılan özellikler grubunun ne olması gerektiğini öğrenin.

    Örneğin, trafikteki ani artışları engellemek de dahil olmak üzere trafik yönetimi özelliklerini birleştirmek isteyebilirsiniz. Bu şekilde, yapılandırmalarını iş kolu mantığını uygulayan iş akışlarının dışında yönetebilirsiniz.

  2. Tıpkı bir API proxy'si geliştirirken olduğu gibi politika ve destekleyici kaynaklar uygulayarak paylaşılan bir akış geliştirin.

    Paylaşılan akış, koşullu adımlardan oluşan dizidir. Yani bir API proxy'si geliştirmeye karar verebilirsiniz. Bir proxy'ye dahil edebileceğiniz politikalar ile kaynakları da dahil edebilirsiniz.

    Ö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 Arhat 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 adım olarak Spike Arrest politikasını 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 akış başlatma hakkında bilgi edinmek için Edge kullanıcı arayüzünde paylaşılan akış oluşturma konusuna bakın.

    API proxy'lerinde olduğu gibi, paylaşılan akış kaynağı yapılarınızı içeren bir zip dosyasını da içe aktarabilirsiniz (proxy'leri içe aktarma hakkında daha fazla bilgi için Yeni bir 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 tüketilecek paylaşılan akışları dağıtmadan önce paylaşılan akışı ortama dağıtın. Paylaşılan akışı, API proxy'si dağıttığınız gibi dağıtırsınız. (Daha fazla bilgi için Dağıtıma genel bakış bölümünü inceleyin.)

    Paylaşılan akış, API proxy'leri ve onu kullanan diğer paylaşılan akışlar ile aynı ortamda dağıtılmalı. 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ı çözümlemeyi mümkün kılar.

    Paylaşılan 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

    Ayrıca, hizmet kesintisi olmadan şu anda dağıtılan bir paylaşılan akışı da değiştirebilirsiniz. (Bu, API proxy'lerine çok benzer. Daha fazla bilgi için management API'yi kullanarak API proxy'leri dağıtma başlıklı makaleye bakın. Management API'sini kullanan istek formunu aşağıda bulabilirsiniz:

    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ışının bir parçası olarak çağırabilmesi için tüketici API proxy'sini geliştirin.

    Bir API proxy'sinden, FlowCallout politikası içeren paylaşılan bir akışa çağrıda bulunursunuz. (Paylaşılan akışı, bir akış kancası kullanarak da proxy'ye ekleyebilirsiniz. Bunun için Akış kancası kullanarak paylaşılan akış ekleme başlıklı bölümü inceleyin.) API proxy'si oluşturmayla ilgili tanıtım eğitimi için İlk API proxy'nizi oluşturma başlıklı makaleye bakın.

    Paylaşılan bir akışı kullanmak için proxy'ye veya tüketilecek paylaşılan akışa bir FlowCallout politikası eklersiniz. Başka bir hizmete çağrı yaptığınız bir Hizmet Çağrısı politikası gibi Akış Akışı da paylaşılan akışa çağrıda bulunur. Harcanan API proxy'si, paylaşılan akıştan sonra ve paylaşılan akışla aynı ortama dağıtılmalıdır. Akış çağrısını Akış Çağrısı politikasını kullanarak test etmek istediğinizde paylaşılan akışın yapılması gerekir.

    Aşağıdaki kodda bir FlowCallout politikası traffic-management-shared adlı paylaşılan bir akışa çağrıda bulunmaktadı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 akışını veya paylaşılan akıştan paylaşılan akış çağırma başlıklı makaleyi inceleyin

  5. Paylaşılan akışı kullanmaya başlamak için tüketici API proxy'sini dağıtın. (Dağıtımla ilgili daha fazla bilgi için Dağıtımı anlama bölümüne bakın.)
  6. Bir API proxy'sinde olduğu gibi takip ederek tekrarlı şekilde geliştirin.

    API proxy'sinde olduğu gibi, mantığı istediğiniz şekilde sağlayana kadar tekrar tekrar çağırarak ve izleyerek paylaşılan bir akış geliştirirsiniz. Bu durumda, paylaşılan akış kendi başına çalışmadığından bir proxy uç noktası çağırır ve proxy'yi izlersiniz.

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

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

      İzlemede, paylaşılan akışın bir gri kutu içine alınmış bir dizi adım veya politika olarak gösterildiğine dikkat edin. Akış çağrısından önce Akış Belirtimi politikalarını temsil eden simgeler. (İzleme hakkında daha fazla bilgi için İzleme aracını kullanma bölümüne bakın.)

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

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

  1. Paylaşılan Akışlar sayfasına aşağıda açıklandığı şekilde erişin. Paylaşılan Akışlar sayfasında, kuruluştaki paylaşılan akışların listesini görüntüleyebilir ve 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 sayfasında oturum açın.
    2. Paylaşılan akışınızı içeren kuruluşu seçin. Kuruluşunuz arasında geçiş yapma başlıklı makaleyi inceleyin.

      Paylaşılan akış, bu kuruluştaki 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)

    Paylaşımlı Akışlar sayfasına Klasik Edge kullanıcı arayüzünü kullanarak erişmek 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. Paylaşılan akışınızı içeren kuruluşu seçin. Kuruluşunuz arasında geçiş yapma başlıklı makaleyi inceleyin.

      Paylaşılan akış, bu kuruluştaki 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. Ü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şturma sayfasında yeni akışı nasıl oluşturmak istediğinizi seçin:
    • Sıfırdan yeni bir akış oluşturun. Politika 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'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 işlevi hakkında daha fazla bilgi vermek 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 öğesine dağıtın.

      6. Yeni paylaşılan akışın oluşturulmasını ve seçtiğiniz ortamlara dağıtılmasını sağlamak için Oluştur ve Dağıt'ı tıklayın. Ortam seçmediyseniz 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 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 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.

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

Akış Açıklama Politikası'nı kullanarak bir proxy'den veya başka bir paylaşılan akıştan paylaşılan 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 listesindeki Uzantı bölümünde FlowCallout'ı 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 StreamCallout 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