Apa itu kebijakan?

Anda sedang melihat dokumentasi Apigee Edge.
Lihat dokumentasi Apigee X.

Apigee Edge memungkinkan Anda melakukan 'program' perilaku API tanpa menulis kode apa pun, dengan menggunakan 'policies'. Kebijakan mirip seperti modul yang menerapkan fungsi pengelolaan terbatas yang spesifik. Kebijakan dirancang untuk memungkinkan Anda 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 mengelola fungsi ini sendiri.

Anda tidak dibatasi 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.

Tonton video ini untuk mengetahui pengantar dan penerapan kebijakan.

Jenis kebijakan

Secara teknis, kebijakan adalah file konfigurasi berformat XML. Setiap struktur jenis kebijakan (misalnya, elemen konfigurasi wajib dan opsional) ditetapkan oleh skema XML. Jika Anda mahir dalam menggunakan alat XML, sebaiknya Anda memahami 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 permintaan dan pesan respons melalui proxy API. Kebijakan ini mendukung kontrol tingkat operasional dan operasional. Peran tersebut 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 mengurangi serangan denial of service.

Keamanan

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

Mediasi

Kebijakan dalam kategori mediasi memungkinkan Anda untuk secara aktif memanipulasi pesan saat mengalir melalui proxy API. Library ini memungkinkan Anda mengubah format pesan, dari XML ke JSON (dan sebaliknya), atau untuk mengubah satu format XML menjadi format XML lainnya. Alat 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 Layanan API, yang memungkinkan Anda mengambil data tentang aplikasi, developer, token keamanan, dan produk API saat runtime.

Perluasan

Kebijakan dalam kategori ekstensi memungkinkan Anda memanfaatkan ekstensi 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 Flow dalam konfigurasi proxy API.

Men-deploy perubahan kebijakan

Agar perubahan kebijakan dapat diterapkan, Anda harus men-deploy revisi proxy API ke suatu 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 diberlakukan 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 ini 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 fault berbasis kebijakan

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

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

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. Kuota
  5. ResponsCache
Alur Respons ProxyEndpoint:
  1. ResponsCache

Transformasi dasar: JSON ke XML

Alur Permintaan:
  1. SpikeArrest
  2. PerlindunganAncamanAncaman
  3. Validasi kunci API
  4. Kuota
  5. JSONToXML
Alur Respons:
  1. XMLToJSON
  2. ResponsCache