Memasang flow bersama menggunakan flow hook

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

Anda dapat membuat alur bersama melakukan pra-pemrosesan permintaan boilerplate atau pascapemrosesan respons di seluruh kumpulan API. Dengan flow hook, Anda memasang flow 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 implementasi proxy.

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 flow bersama ke flow hook. Anda harus menjadi admin org.
  • Anda hanya dapat melampirkan satu flow bersama ke setiap flow hook.
  • Anda dapat melampirkan alur bersama yang sama ke beberapa flow hook.
  • Jika flow bersama yang terpasang ke flow hook menyebabkan kesalahan atau terjadi error selama eksekusi flow 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 flow bersama ke flow hook, lalu melacaknya, di UI Edge Klasik.

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

Alur bersama yang dikaitkan 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 persyaratan keamanan untuk beberapa tim yang mewakili lini bisnis (LOB) yang berbeda. Setiap tim LOB dapat mengembangkan API sesuai dengan persyaratan mereka 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 terlampir melalui flow hook akan dijalankan di 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 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 memasang maksimal satu flow bersama ke flow hook di setiap tempat berikut:

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

  • Flow Hook Pra-target untuk logika yang perlu diterapkan SEBELUM target dipanggil.

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

  • Flow Hook 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 ke dalam log 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 ke dalam log, atau melakukan 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.

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

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

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

    3. Pilih Admin > Environments > Flow Hooks 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 yang merupakan alamat IP atau nama DNS node Server Pengelolaan.
    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 lingkungan dari organisasi ini. Data tersebut tidak akan tersedia dari luar organisasi ini.

    3. Pilih APIs > Environment Configuration > Flow Hooks di menu navigasi atas.
  2. Dalam daftar flow hook, identifikasi flow hook tempat Anda ingin melampirkan flow bersama berdasarkan tempat Anda ingin menjalankan flow bersama.
    Lokasi Kait Alur Deskripsi
    Hook Alur Pra-proxy SEBELUM endpoint proxy dieksekusi
    Kait Alur Pra-target SEBELUM endpoint target dieksekusi
    Pengikat Alur Pasca-target SETELAH respons target dieksekusi
    Pengait Alur Pasca-proxy SETELAH endpoint proxy dan tepat sebelum respons dikirim ke klien
  3. Posisikan kursor di atas flow hook 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 OK.
  7. Pasang flow bersama ke flow hook lainnya sesuai kebutuhan.