Melampirkan alur bersama menggunakan flow hook

Halaman ini berlaku untuk Apigee dan Apigee hybrid.

Lihat Dokumentasi Apigee Edge.

Anda dapat mengatur alur bersama untuk menjalankan prapemrosesan atau respons permintaan boilerplate pascapemrosesan di berbagai rangkaian API. Dengan flow hook, Anda melampirkan flow bersama sehingga dan dijalankan di tempat yang sama untuk semua proxy API yang di-deploy ke lingkungan tertentu. Hal ini memberikan rangkaian logika yang diterapkan dan di-deploy secara terpisah yang bukan merupakan bagian dari kode penerapan berikut.

Catatan: Melampirkan flow bersama ke flow hook adalah yang memiliki dampak yang sangat luas. Alur bersama yang dilampirkan akan dieksekusi pada hook alur untuk setiap proxy yang di-deploy ke lingkungan tersebut.

Karena kode yang dilampirkan ke flow hook berada di luar konteks logika inti proxy API, beberapa perilakunya berbeda dengan proxy API. Perhatikan hal-hal berikut:

• Anda harus memiliki izin untuk melampirkan alur bersama ke flow hook. Anda harus merupakan organisasi admin.
• Anda hanya dapat melampirkan satu flow bersama ke setiap flow hook.
• Anda dapat melampirkan alur bersama yang sama ke beberapa flow hook.
• Jika {i>shared flow<i} yang melekat pada {i>flow hook<i} menimbulkan kesalahan atau ada kesalahan selama {i>shared flow<i} dalam alur eksekusi, pesan akan ditolak dan kesalahan akan dikirim kembali ke pemanggil.
• Jika pesan ditolak selama eksekusi flow hook, detail akan dicatat dalam log ke analitik dalam konteks {i> proxy<i} yang disebut. Alur bersama juga bisa menimbulkan kesalahan dengan kode kustom dan pesan error

Video berikut menunjukkan cara menghubungkan alur bersama ke flow hook, lalu melacaknya, di UI Apigee.

Alur bersama yang dilampirkan ke {i>proxy<i} melalui {i>flow hook<i} menyediakan tempat yang tepat untuk logika yang memberlakukan persyaratan kebijakan yang luas. Misalnya, bayangkan Anda memiliki satu tim yang mengelola satu serangkaian persyaratan keamanan untuk beberapa tim yang mewakili lini bisnis yang berbeda (LOB). Setiap tim LOB dapat mengembangkan API sesuai dengan kebutuhan mereka sendiri, dan tanpa perlu memperhitungkan persyaratan keamanan yang lebih luas. Tim keamanan dapat menerapkan kebijakan keamanan tersebut persyaratan dalam alur bersama, lalu lampirkan alur tersebut ke lingkungan Apigee menggunakan alur menarik. Karena alur bersama bukan merupakan bagian dari kode proxy, tim keamanan dapat merevisinya sesuai kebutuhan tanpa mengganggu kode LOB.

Alur bersama yang dilampirkan melalui flow hook dieksekusi pada posisi tersebut untuk setiap proxy API yang di-deploy ke lingkungan hook proxy. Karena alasan ini, kemampuan untuk menggunakan flow hook tersedia hanya untuk administrator organisasi Apigee.

Untuk informasi selengkapnya tentang alur bersama, lihat Membuat alur bersama yang dapat digunakan kembali.

Anda melampirkan flow bersama ke flow hook menggunakan UI Apigee atau Flowhooks API. Anda dapat pasang paling banyak satu alur bersama ke flow hook di setiap tempat berikut:

• Hook alur pra-proxy untuk logika yang perlu diterapkan SEBELUM endpoint proxy akan dijalankan.

  Misalnya, Anda dapat memiliki logika untuk menegakkan keamanan di semua API dalam satu lingkungan fleksibel App Engine.

• Hook alur pra-target untuk logika yang perlu diterapkan SEBELUM endpoint target akan dijalankan.

  Misalnya, Anda dapat menerapkan logging sebelum permintaan mencapai backend. Anda dapat menegakkan mediasi dengan menghapus kolom tertentu dari permintaan.

• Hook alur pasca-target untuk logika yang perlu diterapkan SETELAH respons target akan dijalankan.

  Cara ini akan ditegakkan segera setelah respons kembali dari backend. Anda dapat menggunakannya untuk mencatat respons backend ke dalam log atau melakukan mediasi dengan menghapus kolom sensitif dari dan respons backend.

• Hook alur pasca-proxy untuk logika yang perlu diterapkan SETELAH endpoint proxy dan tepat sebelum respons dikirim ke klien.

  Hal ini dapat mencakup logika penerapan untuk CORS, logging respons, atau beberapa mashup atau pemformatan.

Melampirkan flow bersama ke flow hook

Untuk melampirkan alur bersama ke flow hook, Anda harus menjadi administrator di organisasi yang berisi alur bersama.

Catatan: Melampirkan flow bersama ke flow hook adalah yang memiliki dampak yang sangat luas. Alur bersama yang dilampirkan akan dieksekusi pada hook alur untuk setiap proxy yang di-deploy ke lingkungan tersebut.

Catatan: Ada versi baru UI Apigee, yang terintegrasi dengan Konsol Google Cloud. UI baru ini disebut Apigee in Cloud Console. Tujuan pada dua tab pertama di bawah ini menjelaskan cara menggunakan Apigee di Konsol Cloud atau Apigee klasik.

Apigee di Konsol Cloud

Untuk melampirkan alur bersama ke flow hook:

1. Buka UI Apigee di Konsol Cloud di browser.
2. Pilih organisasi yang berisi alur bersama Anda. Lihat Beralih antarorganisasi.

   Alur bersama akan tersedia untuk semua proxy API dan alur bersama yang di-deploy ke dari organisasi ini. Data tersebut tidak akan tersedia dari luar organisasi ini.

3. Di panel navigasi sebelah kiri, klik Management > Lingkungan.
4. Pilih lingkungan yang ingin Anda edit dari daftar lingkungan yang tersedia.
5. Klik tab Flow hooks di halaman Environment details.

   Tampilan Flow hook akan ditampilkan.

6. Dalam daftar flow hook, identifikasi flow hook tempat Anda ingin melampirkan alur bersama. Pengait alur yang Anda pilih bergantung pada tempat Anda ingin menjalankan alur bersama.

   Lokasi hook flow	Deskripsi
   Pra-proxy	Dijalankan sebelum endpoint proxy dieksekusi
   Pra-target	Dijalankan sebelum endpoint target dieksekusi
   Pasca-target	Dieksekusi setelah respons target dieksekusi
   Post-proxy	Dijalankan setelah endpoint proxy dan tepat sebelum respons dikirim ke klien

7. Di kotak daftar flow hook yang Anda pilih, pilih alur bersama yang ingin dilampirkan.
8. Lampirkan flow bersama ke flow hook lainnya sesuai kebutuhan.
9. Klik Save untuk melampirkan alur bersama yang dipilih ke flow hook.

Apigee Klasik

Untuk melampirkan alur bersama ke flow hook:

1. Login ke UI Apigee.
2. Pilih organisasi yang berisi alur bersama Anda. Lihat Beralih antarorganisasi.

   Alur bersama akan tersedia untuk semua proxy API dan alur bersama yang di-deploy ke dari organisasi ini. Data tersebut tidak akan tersedia dari luar organisasi ini.

3. Pilih Admin > Lingkungan > Hook flow di menu navigasi kiri.

   Tampilan Flow hook menampilkan:

   

4. Dari menu drop-down lingkungan, pilih lingkungan yang ingin Anda ubah.
5. Dalam daftar flow hook, identifikasi flow hook tempat Anda ingin melampirkan alur bersama. Pengait alur yang Anda pilih bergantung pada tempat Anda ingin menjalankan alur bersama.

   Lokasi hook flow	Deskripsi
   Pra-proxy	Dijalankan sebelum endpoint proxy dieksekusi
   Pra-target	Dijalankan sebelum endpoint target dieksekusi
   Post-proxy	Dijalankan setelah endpoint proxy dan tepat sebelum respons dikirim ke klien
   Pasca-target	Dieksekusi setelah respons target dieksekusi

6. Posisikan kursor di atas flow hook dalam daftar untuk menampilkan kolom tindakan.
7. Klik Edit.
8. Pada dialog Alur Bersama, pilih alur bersama yang ingin Anda lampirkan di Menu Alur bersama.
9. Klik Oke.
10. Lampirkan flow bersama ke flow hook lainnya sesuai kebutuhan.