Apa yang dimaksud dengan kebijakan?

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

Apigee Edge memungkinkan Anda 'memprogram' perilaku API tanpa menulis kode apa pun, dengan menggunakan 'kebijakan'. Kebijakan seperti modul yang mengimplementasikan fungsi pengelolaan tertentu yang terbatas. Kebijakan dirancang agar Anda dapat menambahkan jenis kemampuan pengelolaan umum ke API dengan mudah dan andal. Kebijakan menyediakan fitur seperti keamanan, pembatasan kapasitas, transformasi, dan kemampuan mediasi, sehingga Anda tidak perlu membuat kode dan memelihara fungsi ini sendiri.

Anda tidak terbatas pada kumpulan jenis kebijakan yang disediakan oleh Apigee Edge. Anda juga dapat menulis skrip dan kode kustom (seperti aplikasi JavaScript dan Node.js), yang memperluas fungsi proxy API dan memungkinkan Anda berinovasi di atas kemampuan pengelolaan dasar yang didukung oleh Kebijakan Apigee.

Jenis kebijakan

Secara teknis, kebijakan adalah file konfigurasi berformat XML. Struktur setiap jenis kebijakan (misalnya, elemen konfigurasi wajib dan opsional) ditentukan oleh skema XML. Jika Anda mahir menggunakan alat XML, sebaiknya pahami skema kebijakan dalam contoh Platform API di GitHub.

Jenis Kebijakan Edge dikelompokkan ke dalam kategori fungsional berikut:

Pengelolaan traffic

Kebijakan dalam kategori pengelolaan traffic memungkinkan Anda mengontrol alur pesan permintaan dan respons melalui proxy API. Kebijakan ini mendukung kontrol tingkat operasional dan bisnis. Fitur ini memberi Anda kontrol atas throughput mentah, dan juga dapat mengontrol traffic berdasarkan per aplikasi. Jenis kebijakan pengelolaan traffic memungkinkan Anda menerapkan kuota, dan juga membantu Anda memitigasi serangan penolakan layanan.

Keamanan

Kebijakan dalam kategori keamanan mendukung autentikasi, otorisasi, serta keamanan berbasis konten.

Mediasi

Kebijakan dalam kategori mediasi memungkinkan Anda memanipulasi pesan secara aktif saat pesan tersebut mengalir melalui proxy API. Dengan kebijakan ini, Anda dapat mengubah format pesan, dari XML ke JSON (dan sebaliknya), atau mengubah satu format XML ke format XML lainnya. Dengan fungsi ini, Anda juga dapat mengurai pesan, membuat pesan baru, dan mengubah nilai pada pesan keluar. Kebijakan Mediasi juga berinteraksi dengan layanan dasar yang diekspos oleh Layanan API, sehingga Anda dapat mengambil data tentang aplikasi, developer, token keamanan, dan produk API saat runtime.

Ekstensi

Kebijakan dalam kategori ekstensi memungkinkan Anda memanfaatkan ekstensibilitas Layanan API untuk menerapkan perilaku kustom dalam bahasa pemrograman pilihan Anda.

Setiap jenis Kebijakan didokumentasikan secara mendetail dalam Ringkasan referensi kebijakan. Topik ini menunjukkan interaksi umum, yang menunjukkan cara membuat Kebijakan, dan cara melampirkannya ke Alur dalam konfigurasi proxy API.

Men-deploy perubahan kebijakan

Agar perubahan kebijakan diterapkan, Anda harus men-deploy revisi proxy API ke lingkungan. Setelah melampirkan kebijakan atau membuat perubahan pada kebijakan yang ada, gunakan UI pengelolaan atau API pengelolaan untuk men-deploy perubahan.

Memverifikasi penegakan kebijakan

Untuk memverifikasi bahwa kebijakan diterapkan dengan benar, API harus dipanggil oleh klien HTTP. Untuk memverifikasi konfigurasi Kuota ini, kirimkan beberapa permintaan ke API, yang melebihi batas kuota yang Anda tetapkan dalam kebijakan kuota. (Jalur URI, yang dikonfigurasi sebagai setelan jalur dasar di ProxyEndpoint, dalam permintaan di bawah adalah /weather).

http://{org_name}-test.apigee.net/weather/forecastrss?w=12797282

Setelah mengirimkan lebih dari 1 permintaan dalam satu menit, Anda akan melihat pesan error berikut:

{  
   "fault":{  
      "faultstring":"policies.ratelimit.QuotaViolation",
      "detail":{  
         "errorcode":"policies.ratelimit.QuotaViolation"
      }
   }
}

Hal ini menunjukkan bahwa kebijakan Kuota diterapkan oleh Layanan API.

Penanganan kesalahan berbasis kebijakan

Perhatikan format pesan error di atas. Objek ini berisi properti faultstring dan properti errorcode. Dalam banyak kasus, Anda perlu menerapkan beberapa perilaku untuk menangani error ini. Misalnya, Anda mungkin ingin mengirimkan pesan yang disesuaikan kepada developer yang aplikasinya telah melampaui Kuota.

Untuk mengetahui informasi selengkapnya tentang penanganan gangguan, lihat Menangani gangguan.

Praktik terbaik: Set kebijakan umum

Untuk memenuhi persyaratan pengelolaan dasar, proxy API biasanya menerapkan kebijakan berikut:

Validasi kunci API dasar

1. SpikeArrest
2. XMLThreatProtection atau JSONThreatProtection
3. Validasi kunci API
4. Kuota
5. ResponseCache

1. ResponseCache

Transformasi dasar: JSON ke XML

1. SpikeArrest
2. JSONThreatProtection
3. Validasi kunci API
4. Kuota
5. JSONToXML

1. XMLToJSON
2. ResponseCache