Melampirkan alur bersama menggunakan hook alur

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

Anda dapat membuat alur bersama melakukan pra-pemrosesan permintaan boilerplate atau pasca-pemrosesan respons di seluruh kumpulan API. Dengan flow hook, Anda melampirkan alur bersama sehingga alur tersebut dijalankan 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 merupakan bagian dari kode implementasi proxy.

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

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

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

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

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

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

Anda melampirkan alur bersama ke flow hook menggunakan konsol pengelolaan Apigee Edge. Anda dapat melampirkan paling banyak satu alur bersama ke flow hook di setiap tempat berikut:

  • Pre-proxy Flow Hook untuk logika yang perlu diterapkan SEBELUM endpoint proxy dijalankan.

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

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

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

Melampirkan alur bersama ke flow hook

Untuk melampirkan alur bersama ke flow hook, 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 proxy API dan alur bersama yang di-deploy ke an lingkungan dari organisasi ini. Alur bersama tidak akan tersedia dari luar organisasi ini.

    3. Pilih Admin > Environments > Flow Hooks di panel navigasi 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 dari node Management Server.
    2. Pilih organisasi yang berisi alur bersama Anda. Lihat Beralih antar-organisasi.

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

    3. Pilih APIs > Environment Configuration > Flow Hooks di panel navigasi atas.
  2. Dalam daftar flow hook, identifikasi flow hook yang ingin Anda lampirkan alur bersama berdasarkan tempat Anda ingin alur bersama dijalankan.
    Lokasi Flow Hook Deskripsi
    Pre-proxy Flow Hook SEBELUM endpoint proxy dijalankan
    Pre-target Flow Hook SEBELUM endpoint target dijalankan
    Post-target Flow Hook SETELAH respons target dijalankan
    Post-proxy Flow Hook SETELAH endpoint proxy dan tepat sebelum respons dikirim ke klien
  3. Arahkan kursor ke flow hook dalam daftar untuk menampilkan kolom tindakan.
  4. Klik .
  5. Dalam dialog Shared Flow, pilih alur bersama yang ingin Anda lampirkan di dropdown Shared flow.
  6. Klik OK.
  7. Lampirkan alur bersama ke flow hook lain sesuai kebutuhan.