Melampirkan dan mengonfigurasi kebijakan di UI

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

Menambahkan kemampuan berbasis kebijakan ke proxy API merupakan proses dua langkah:

1. Konfigurasi instance jenis kebijakan.
2. Lampirkan instance kebijakan ke Flow.

Diagram di bawah menunjukkan hubungan antara kebijakan dan Flow. Seperti yang dapat Anda lihat, kebijakan dilampirkan ke Flow sebagai "Langkah" pemrosesan. Guna mengonfigurasi perilaku yang diinginkan untuk API, Anda perlu memahami sedikit tentang Flow. (Topik ini telah dibahas sebelumnya dalam Mengonfigurasi alur.)

Salah satu jenis kebijakan yang umum digunakan adalah SpikeArrest. SpikeArrest mencegah peningkatan traffic pesan secara tiba-tiba yang mungkin membanjiri layanan backend Anda.

Melampirkan kebijakan ke flow

Untuk melampirkan kebijakan ke Flow:

1. Pilih proxy API lalu buka tampilan Develop.
2. Di API Proxy Editor, pilih flow yang ingin Anda tambahi kebijakan di panel Navigator.
   Misalnya, alur PreFlow dipilih untuk endpoint proxy API default pada gambar berikut:
   
3. Di tampilan Design, klik +Step yang terkait dengan alur permintaan atau respons untuk melampirkan kebijakan. Misalnya:
   
   Dialog Add Step akan terbuka dan menampilkan daftar kebijakan yang dikategorikan.
   
4. Scroll dan pilih jenis kebijakan yang ingin Anda lampirkan ke alur yang dipilih.
5. Ubah kolom berikut.

   • Nama Tampilan: Nama tampilan unik untuk kebijakan. UI akan menghasilkan nama default, tetapi sebaiknya buat nama deskriptif untuk kebijakan. Hal ini akan memastikan developer lain di organisasi Anda dapat dengan mudah memahami tujuan dari kebijakan tersebut.

   • Nama: Nama unik untuk kebijakan. Nama kebijakan cocok dengan nama tampilan dengan pengecualian berikut:

     • Spasi diganti dengan tanda hubung.

     • Tanda hubung berurutan diganti dengan tanda hubung tunggal.

     • Karakter yang bukan alfanumerik, seperti tanda pagar, tanda persen, ampersand, dan sebagainya, kecuali untuk tanda hubung, garis bawah, dan spasi (yang diganti, seperti disebutkan di atas), akan dihapus.

6. Klik Tambahkan.

   Kebijakan tersebut disertakan pada alur yang dipilih.

Setelah kebijakan dilampirkan, Anda akan melihat kebijakan ditampilkan dalam tampilan Designer untuk alurnya, dalam contoh ini PreFlow endpoint proxy default, dan dalam daftar Kebijakan di panel Navigation. Tampilan Code, yang menampilkan XML untuk kebijakan yang baru dilampirkan, akan ditampilkan di bawah tampilan Designer. Edge menghasilkan instance kebijakan yang berisi serangkaian nilai default yang wajar.

Menambahkan kebijakan tanpa melampirkannya ke flow

Untuk menambahkan kebijakan tanpa melampirkannya ke flow, yang berguna untuk Menangani kesalahan, klik + di panel Kebijakan pada tampilan Navigator untuk membuka dialog Add Policy dan menambahkan kebijakan (seperti yang dijelaskan pada langkah 4 hingga 6 di bagian sebelumnya).

Kebijakan yang tidak dilampirkan ke flow apa pun akan ditandai dengan ikon "terpisah" dalam daftar Kebijakan, seperti yang ditunjukkan di sebelah kebijakan pesan kunci API yang ditunjukkan pada gambar sebelumnya.

Setelah membuat kebijakan, Anda dapat melampirkannya ke alur dengan menarik lalu melepasnya dari daftar Kebijakan ke alur yang diinginkan dalam tampilan Desainer.

Melepaskan kebijakan dari flow

Untuk melepaskan kebijakan dari Alur, pilih Alur. Arahkan kursor ke ikon untuk kebijakan pada tampilan Designer di Flow. Klik X di lingkaran yang muncul di ikon.

Menghapus instance kebijakan

Untuk menghapus instance kebijakan, arahkan kursor ke entri untuk kebijakan dalam tampilan Navigator. Klik X dalam lingkaran yang muncul di sebelah kanan entri.

Mengonfigurasi kebijakan di UI

Saat menghasilkan instance kebijakan, UI akan menerapkan nilai default yang wajar untuk setelan umum. Anda mungkin perlu memodifikasi setelan ini untuk memenuhi persyaratan.

Contoh:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<SpikeArrest async="false" continueOnError="false" enabled="true" name="spikearrest-1">
  <DisplayName>SpikeArrest-1</DisplayName>
  <FaultRules/>
  <Properties/>
  <Identifier ref="request.header.some-header-name"/>
  <MessageWeight ref="request.header.weight"/>
  <Rate>30ps</Rate>
</SpikeArrest>

Anda dapat mengonfigurasi kebijakan dengan langsung mengedit konfigurasi XML-nya dalam tampilan Code. Misalnya, tingkat pesan puncak untuk kebijakan Penangkapan Spike awalnya ditetapkan ke 30 pesan per detik. Anda dapat mengubah tarif puncak dengan mengubah nilai elemen <Rate> dalam XML untuk kebijakan tersebut. Untuk detail lebih lanjut tentang mengonfigurasi kebijakan, lihat Referensi Kebijakan.

Anda juga dapat memotong dan menempel kebijakan ke tampilan Kode. Ini adalah cara yang efektif untuk menggunakan kembali kebijakan dari contoh yang tersedia di GitHub.

Saat Anda membuat perubahan pada definisi kebijakan di tampilan Code, perubahan tersebut akan tercermin dalam Property Inspector. Hal sebaliknya juga berlaku — ubah di Property Inspector agar muncul dalam XML dalam tampilan Code.

Untuk dokumentasi khusus tentang kebijakan Kuota yang digunakan dalam topik ini, lihat Kebijakan kuota.