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 mana yang akan diterapkan dan endpoint target mana yang akan dirutekan, dan ketentuan yang harus dipenuhi untuk kebijakan atau aturan rute yang akan dijalankan.

Singkatnya, konfigurasi ProxyEndpoint mendefinisikan semua yang perlu Compute Engine API.

Anti-pola

Proxy API dapat memiliki satu atau beberapa endpoint proxy. Menentukan beberapa ProxyEndpoint mudah dan mekanisme sederhana untuk mengimplementasikan banyak 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 ProxyEndpoint dalam satu proxy API, Anda secara konseptual menggabungkan banyak API yang tidak terkait menjadi satu artefak. Hal ini membuat proxy API lebih sulit untuk membaca, memahami, men-debug, dan memelihara. Hal ini bertentangan dengan filosofi utama {i>proxy<i} API: membuat memudahkan developer untuk membuat dan memelihara API.

Dampak

Beberapa ProxyEndpoint dalam proxy API dapat:

  • Sulit bagi developer untuk memahami dan memelihara proxy API.
  • Melakukan obfuscation pada analisis. Secara default, data analisis digabungkan di tingkat proxy. Tidak ada pengelompokan metrik berdasarkan endpoint proxy, kecuali jika Anda membuat laporan kustom.
  • Buatlah menjadi sulit untuk memecahkan masalah terkait proxy API.

Praktik terbaik

Bila 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 pra- atau pasca-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, menggunakan alur bersyarat dalam satu ProxyEndpoint.
  4. Jika ada proxy API dengan beberapa ProxyEndpoint dan jika tidak ada masalah, maka tidak perlu melakukan tindakan apa pun.

Menggunakan satu ProxyEndpoint per proxy API akan menghasilkan:

  1. Proxy 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 ProxyEndpoint
  3. Pemecahan masalah dan penyelesaian masalah yang lebih cepat

Bacaan lebih lanjut