Melampirkan alur bersama menggunakan flow hook

Halaman ini berlaku untuk Apigee dan Apigee Hybrid.

Baca dokumentasi Apigee Edge.

Anda dapat membuat alur bersama melakukan pra-pemrosesan permintaan boilerplate atau merespons pascapemrosesan di seluruh kumpulan API. Dengan flow hook, Anda melampirkan alur bersama sehingga dijalankan di tempat yang sama untuk semua proxy API yang di-deploy ke lingkungan tertentu. Hal ini memberi Anda urutan logika yang diterapkan secara terpisah dan di-deploy yang bukan bagian dari kode penerapan proxy.

Catatan: Melampirkan flow bersama ke flow hook adalah tindakan yang memiliki efek yang sangat luas. Alur bersama terlampir akan dijalankan pada titik flow hook untuk setiap proxy yang di-deploy ke lingkungan tersebut.

Karena kode yang terpasang 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 menjadi admin org.
• Anda hanya dapat melampirkan satu alur bersama ke setiap flow hook.
• Anda dapat memasang alur bersama yang sama ke beberapa flow hook.
• Jika alur bersama yang terpasang ke flow hook menimbulkan kesalahan atau terjadi error selama eksekusi alur bersama, pesan akan ditolak dan kesalahan akan dikirim kembali ke pemanggil.
• Jika pesan ditolak selama eksekusi flow hook, detailnya akan dicatat ke analisis dalam konteks proxy yang dipanggil. Alur bersama juga dapat menampilkan kesalahan dengan kode khusus dan pesan error

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

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

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

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

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

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

  Misalnya, Anda dapat memiliki logika untuk menerapkan keamanan di semua API dalam suatu lingkungan.

• Hook flow pra-target untuk logika yang perlu diterapkan SEBELUM endpoint target dieksekusi.

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

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

  Hal ini akan diterapkan tepat setelah respons kembali dari backend. Anda dapat menggunakannya untuk mencatat respons backend atau melakukan beberapa mediasi dengan menghapus kolom sensitif dari 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 mashup atau pemformatan.

Melampirkan alur bersama ke flow hook

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

Catatan: Melampirkan flow bersama ke flow hook adalah tindakan yang memiliki efek yang sangat luas. Alur bersama terlampir akan dijalankan pada titik hook alur untuk setiap proxy yang di-deploy ke lingkungan tersebut.

Catatan: Saat ini ada versi baru UI Apigee, yang terintegrasi dengan Konsol Google Cloud. UI baru ini disebut Apigee in Cloud Console. Petunjuk dalam dua tab pertama di bawah 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 yang dibagikan. Lihat Beralih antarorganisasi.

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

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

   Tampilan Flow hooks akan ditampilkan.

6. Dalam daftar flow hook, identifikasikan flow hook tempat Anda ingin menempelkan alur bersama. {i>Flow hook<i} yang Anda pilih bergantung pada di mana Anda ingin menjalankan alur bersama.

   Lokasi flow hook	Deskripsi
   Pra-proxy	Dijalankan sebelum endpoint proxy dieksekusi
   Pra-target	Dijalankan sebelum endpoint target dieksekusi
   Pasca-target	Dijalankan 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. Pasang 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 yang dibagikan. Lihat Beralih antarorganisasi.

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

3. Pilih Admin > Environments > Flow hook di menu navigasi sebelah kiri.

   Tampilan Flow hooks menampilkan:

   

4. Dari menu drop-down lingkungan, pilih lingkungan yang ingin Anda ubah.
5. Dalam daftar flow hook, identifikasikan flow hook tempat Anda ingin menempelkan alur bersama. {i>Flow hook<i} yang Anda pilih bergantung pada di mana Anda ingin menjalankan alur bersama.

   Lokasi flow hook	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	Dijalankan setelah respons target dieksekusi

6. Posisikan kursor di atas flow hook dalam daftar untuk menampilkan kolom tindakan.
7. Klik Edit.
8. Pada dialog Shared Flow, pilih alur bersama yang ingin Anda lampirkan di menu Shared flow.
9. Klik OK.
10. Pasang flow bersama ke flow hook lainnya sesuai kebutuhan.