Anti-pola: Menentukan beberapa ProxyEndpoint dalam proxy API

Anda sedang melihat dokumentasi Apigee dan Apigee Hybrid.
Lihat dokumentasi Apigee Edge.

Konfigurasi ProxyEndpoint menentukan cara aplikasi klien menggunakan API melalui Apigee. ProxyEndpoint menentukan URL proxy API dan perilaku proxy: kebijakan yang diterapkan dan endpoint target yang akan dirutekan, serta kondisi yang harus dipenuhi agar kebijakan atau aturan perutean tersebut dijalankan.

Singkatnya, konfigurasi ProxyEndpoint menentukan semua yang perlu dilakukan untuk mengimplementasikan API.

Antipola

Proxy API dapat memiliki satu atau beberapa endpoint proxy. Menentukan beberapa ProxyEndpoint adalah mekanisme yang mudah dan sederhana untuk menerapkan beberapa API dalam satu proxy. Hal ini memungkinkan Anda menggunakan kembali kebijakan dan/atau logika bisnis sebelum dan setelah pemanggilan TargetEndpoint.

Di sisi lain, saat menentukan beberapa ProxyEndpoint dalam satu proxy API, Anda pada akhirnya akan menggabungkan banyak API yang tidak terkait menjadi satu artefak secara konseptual. Membuat proxy API lebih sulit untuk dibaca, dipahami, di-debug, dan dikelola. Hal ini menggantikan filosofi utama proxy API: memudahkan developer untuk membuat dan mengelola API.

Dampak

Beberapa ProxyEndpoint dalam proxy API dapat:

  • Sulit bagi developer untuk memahami dan memelihara proxy API.
  • Meng-obfuscate analisis. Secara default, data analisis digabungkan pada tingkat proxy. Tidak ada pengelompokan metrik berdasarkan endpoint proxy, kecuali jika Anda membuat laporan kustom.
  • Buatlah pemecahan masalah terkait proxy API.

Praktik terbaik

Saat Anda menerapkan proxy API baru atau mendesain ulang proxy API yang ada, gunakan praktik terbaik berikut:

  1. Mengimplementasikan satu proxy API dengan satu ProxyEndpoint.
  2. Jika ada beberapa API yang menggunakan server target yang sama dan/atau memerlukan logika yang sama sebelum atau setelah pemanggilan server target, pertimbangkan untuk menggunakan alur bersama untuk menerapkan logika tersebut di proxy API yang berbeda.
  3. Jika ada beberapa API yang memiliki jalur dasar awal yang sama, tetapi akhirannya berbeda, gunakan alur bersyarat dalam satu ProxyEndpoint.
  4. Jika ada proxy API dengan beberapa ProxyEndpoint dan jika tidak ada masalah dengan proxy tersebut, Anda tidak perlu melakukan tindakan apa pun.

Menggunakan satu ProxyEndpoint per proxy API akan menghasilkan:

  1. Proxy yang lebih sederhana dan lebih mudah dikelola
  2. Informasi yang lebih baik di Analytics, seperti performa proxy dan target waktu respons, akan dilaporkan secara terpisah, bukan digabungkan untuk semua ProxyEndpoint
  3. Pemecahan masalah dan penyelesaian masalah yang lebih cepat

Bacaan lebih lanjut