Melampirkan alur bersama menggunakan hook alur

Halaman ini berlaku untuk Apigee dan Apigee hybrid.

Lihat dokumentasi Apigee Edge.

Anda dapat membuat alur bersama melakukan prapemrosesan permintaan boilerplate atau pascapemrosesan respons di seluruh kumpulan API. Dengan hook alur, Anda melampirkan alur bersama sehingga alur tersebut dieksekusi di tempat yang sama untuk semua proxy API yang di-deploy ke lingkungan tertentu. Hal ini memberi Anda urutan logika yang diimplementasikan dan di-deploy secara terpisah yang bukan bagian dari kode implementasi proxy.

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

Karena kode yang dilampirkan ke hook alur 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 hook alur. Anda harus menjadi admin organisasi.
• Anda hanya dapat melampirkan satu alur bersama ke setiap hook alur.
• Anda dapat melampirkan alur bersama yang sama ke beberapa hook alur.
• Jika alur bersama yang dilampirkan ke hook alur menimbulkan error atau ada error selama eksekusi alur bersama, pesan akan ditolak dan error akan dikirim kembali ke pemanggil.
• Jika pesan ditolak selama eksekusi hook alur, detail akan dicatat ke log analytics dalam konteks proxy yang dipanggil. Alur bersama juga dapat menampilkan error dengan kode kustom dan pesan error

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

Alur bersama yang dilampirkan ke proxy melalui hook alur menyediakan tempat yang tepat untuk logika yang menerapkan persyaratan kebijakan yang luas. Misalnya, bayangkan Anda memiliki satu tim yang mengelola satu kumpulan persyaratan keamanan untuk beberapa tim yang mewakili berbagai lini bisnis (LOB). Setiap tim LOB dapat mengembangkan API sesuai dengan persyaratannya sendiri, dan tanpa perlu mempertimbangkan persyaratan keamanan yang lebih luas. Tim keamanan dapat menerapkan persyaratan keamanan tersebut dalam alur bersama, lalu melampirkan alur ke lingkungan Apigee menggunakan hook alur. Karena alur bersama bukan bagian dari kode proxy, tim keamanan dapat merevisinya sesuai kebutuhan tanpa mengganggu kode LOB.

Alur bersama yang dilampirkan melalui hook alur dijalankan di posisi tersebut untuk setiap proxy API yang di-deploy ke lingkungan hook proxy. Oleh karena itu, kemampuan untuk menggunakan hook alur hanya tersedia untuk administrator organisasi Apigee.

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

Anda melampirkan alur bersama ke hook alur menggunakan UI Apigee atau Flowhooks API. Anda dapat melampirkan maksimal satu alur bersama ke hook alur 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 lingkungan.

• Hook alur 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 dijalankan.

  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 beberapa logika penerapan untuk CORS, mencatat respons, atau melakukan beberapa mashup atau pemformatan.

Melampirkan alur bersama ke hook alur

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

Catatan: Melampirkan alur bersama ke hook alur adalah tindakan yang memiliki efek yang sangat luas. Alur bersama yang dilampirkan akan dijalankan pada titik 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 di konsol Cloud. Petunjuk di dua tab pertama di bawah menjelaskan cara menggunakan Apigee di konsol Cloud atau Apigee klasik.

Apigee di konsol Cloud

Untuk melampirkan alur bersama ke hook alur:

1. Buka UI Apigee di Cloud Console di browser.
2. Pilih organisasi yang berisi alur bersama Anda. Lihat Beralih antar-organisasi.

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

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

   Tampilan Flow hooks akan ditampilkan.

6. Dalam daftar hook alur, identifikasi hook alur yang ingin Anda lampirkan ke alur bersama. Hook alur yang Anda pilih bergantung pada tempat Anda ingin alur bersama dieksekusi.

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

7. Di kotak daftar hook alur yang Anda pilih, pilih alur bersama yang ingin Anda lampirkan.
8. Lampirkan alur bersama ke hook alur lain sesuai kebutuhan.
9. Klik Simpan untuk melampirkan alur bersama yang dipilih ke hook alur.

Apigee Klasik

Untuk melampirkan alur bersama ke hook alur:

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

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

3. Pilih Admin > Lingkungan > Hook alur di menu navigasi sebelah kiri.

   Tampilan Flow hook menampilkan:

   

4. Dari menu drop-down lingkungan, pilih lingkungan yang ingin Anda ubah.
5. Dalam daftar hook alur, identifikasi hook alur yang ingin Anda lampirkan ke alur bersama. Hook alur yang Anda pilih bergantung pada tempat Anda ingin alur bersama dieksekusi.

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

6. Arahkan kursor ke hook alur 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 Oke.
10. Lampirkan alur bersama ke hook alur lain sesuai kebutuhan.