Apa yang dimaksud dengan kebijakan?

Halaman ini berlaku untuk Apigee dan Apigee hybrid.

Lihat dokumentasi Apigee Edge.

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

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

Topik ini memberikan ringkasan tentang jenis dan penggunaan kebijakan di Apigee. Untuk informasi tentang kebijakan tertentu, lihat Ringkasan referensi kebijakan.

Jenis dan kategori kebijakan

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

Kebijakan Apigee dikelompokkan ke dalam kategori fungsional berikut. Kebijakan yang tersedia untuk setiap kategori kebijakan tercantum dalam Ringkasan referensi kebijakan.

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 per aplikasi. Jenis kebijakan pengelolaan traffic memungkinkan Anda menerapkan kuota, dan juga membantu Anda memitigasi serangan denial of service.

Keamanan

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

Mediasi

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

Ekstensi

Kebijakan dalam kategori ekstensi memungkinkan Anda memanfaatkan ekstensi Apigee untuk menerapkan perilaku kustom dalam bahasa pemrograman pilihan Anda.

Melampirkan kebijakan

Agar kebijakan diterapkan ke proxy API, Anda harus melampirkan kebijakan tersebut ke proxy dalam alur. Untuk mengetahui informasinya, lihat topik lain di bagian ini, termasuk Melampirkan dan mengonfigurasi kebijakan di UI dan Melampirkan dan mengonfigurasi kebijakan dalam file XML.

Men-deploy perubahan kebijakan

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

Memverifikasi penerapan kebijakan

Untuk memverifikasi bahwa kebijakan diterapkan dengan benar, API harus dipanggil oleh klien HTTP. Untuk memverifikasi konfigurasi Quota, tetapkan kuota (misalnya, satu permintaan per menit), lalu kirim 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 satu 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 Quota sedang diterapkan oleh Apigee.

Penanganan error berbasis kebijakan

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

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

Praktik terbaik: Kumpulan kebijakan umum

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

Validasi kunci API dasar

Alur Permintaan ProxyEndpoint:
  1. SpikeArrest
  2. XMLThreatProtection atau JSONThreatProtection
  3. Validasi kunci API
  4. Quota
  5. ResponseCache
Alur Respons ProxyEndpoint:
  1. ResponseCache

Transformasi dasar: JSON ke XML

Alur Permintaan:
  1. SpikeArrest
  2. JSONThreatProtection
  3. Validasi kunci API
  4. Quota
  5. JSONToXML
Alur Respons:
  1. XMLToJSON
  2. ResponseCache