Melampirkan alur bersama menggunakan hook alur

Anda sedang melihat dokumentasi Apigee Edge.
Buka dokumentasi Apigee X.
info

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.

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 ke 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 Edge Klasik.

Video berikut menunjukkan cara menghubungkan alur bersama ke hook alur, lalu melacaknya, di UI pengalaman Edge Baru.

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 Edge 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 Edge.

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

Anda melampirkan alur bersama ke hook alur menggunakan konsol pengelolaan Apigee Edge. 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 target dipanggil.

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

  • Post-target Flow Hook 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.

  • Post-proxy Flow Hook 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.

  1. Akses halaman Flow Hooks, seperti yang dijelaskan di bawah.

    Edge

    Untuk mengakses halaman Flow Hooks menggunakan UI Edge:

    1. Login ke apigee.com/edge.
    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.

    Edge Klasik (Private Cloud)

    Untuk mengakses halaman Flow Hooks menggunakan UI Edge Klasik:

    1. Login ke http://ms-ip:9000, dengan ms-ip adalah alamat IP atau nama DNS node Server Pengelolaan.
    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 APIs > Environment Configuration > Flow Hooks di menu navigasi atas.
  2. Dalam daftar hook alur, identifikasi hook alur tempat Anda ingin melampirkan alur bersama berdasarkan tempat Anda ingin alur bersama dieksekusi.
    Lokasi Flow Hook Deskripsi
    Flow Hook Pra-proxy SEBELUM endpoint proxy dieksekusi
    Hook Alur Pra-target SEBELUM endpoint target dieksekusi
    Flow Hook Pasca-target SETELAH respons target dieksekusi
    Hook Alur Pasca-proxy SETELAH endpoint proxy dan tepat sebelum respons dikirim ke klien
  3. Arahkan kursor ke hook alur dalam daftar untuk menampilkan kolom tindakan.
  4. Klik .
  5. Pada dialog Alur Bersama, pilih alur bersama yang ingin Anda lampirkan di dropdown Alur bersama.
  6. Klik Oke.
  7. Lampirkan alur bersama ke hook alur lain sesuai kebutuhan.