Antipola: Menentukan beberapa ProxyEndpoints di 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 mana yang akan diterapkan dan endpoint target mana yang akan dirutekan, serta kondisi yang perlu dipenuhi agar kebijakan atau aturan rute ini dapat dijalankan.

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

Antipola

Proxy API dapat memiliki satu atau beberapa endpoint proxy. Menentukan beberapa ProxyEndpoints 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 sesudah pemanggilan TargetEndpoint.

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

Dampak

Beberapa ProxyEndpoints di proxy API dapat:

  • Sulitkan developer untuk memahami dan mengelola proxy API.
  • Menyamarkan analisis. Secara default, data analisis digabungkan di tingkat proxy. Tidak ada pengelompokan metrik menurut endpoint proxy kecuali jika Anda membuat laporan kustom.
  • Sulit memecahkan masalah terkait proxy API.

Praktik terbaik

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

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

Menggunakan satu ProxyEndpoint per proxy API akan menyebabkan:

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

Bacaan lebih lanjut