Melampirkan kebijakan ke Alur ProxyEndpoint atau TargetEndpoint

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

Kebijakan tidak akan dieksekusi hingga dilampirkan ke Alur. Anda dapat membuat lampiran Kebijakan dengan memberi nama Kebijakan dalam konfigurasi Langkah.

Pilihan titik lampiran sangat penting untuk perilaku proxy API Anda. Misalnya, jika Anda melampirkan kebijakan Kuota ke Alur respons, Kuota akan diterapkan setelah pesan permintaan dikirim ke layanan backend. Hal ini akan mengalahkan tujuan penerapan kebijakan Kuota. Oleh karena itu, Anda harus melampirkan kebijakan Kuota sebagai Langkah pemrosesan pada Alur permintaan.

Format lampiran kebijakan adalah:

<Step>
    <Name>{policy_name}</Name>
</Step>

Contoh:

<Step>
    <Name>QuotaPolicy</Name>
</Step>

Kebijakan dilampirkan ke Alur dengan menambahkan konfigurasi Langkah ke elemen Alur permintaan atau respons yang sesuai dalam konfigurasi ProxyEndpoint atau TargetEndpoint.

Anda dapat melampirkan kebijakan ke Alur permintaan atau respons. Alur permintaan dan respons dibagi lagi menjadi PreFlow dan PostFlow.

Contoh berikut menunjukkan konfigurasi ProxyEndpoint minimal, tanpa lampiran kebijakan. Konfigurasi ini hanya menentukan HTTPProxyConnection (masuk) dan RouteRule.

<ProxyEndpoint name="default">
    <HTTPProxyConnection>
        <BasePath>/weather</BasePath>
        <VirtualHost>default</VirtualHost>
    </HTTPProxyConnection>
    <RouteRule name="default">
        <TargetEndpoint>default</TargetEndpoint>
    </RouteRule>
</ProxyEndpoint>

Anda harus mengubah konfigurasi ini agar ProxyEndpoint menerapkan kebijakan Kuota (sebagai Langkah pemrosesan) sebelum proxy API melakukan pemrosesan lainnya. Jika developer telah melampaui Kuota, Anda tidak ingin membuang resource komputasi untuk permintaan tambahan.

Untuk menerapkan konfigurasi ini, Anda melampirkan Langkah pemrosesan ke PreFlow permintaan sebagai berikut:

<ProxyEndpoint name="default">
  <PreFlow>
    <Request>
      <Step><Name>QuotaPolicy</Name></Step>
    </Request>
  </PreFlow>
  <HTTPProxyConnection> 
    <BasePath>/weather</BasePath> 
    <VirtualHost>default</VirtualHost> 
  </HTTPProxyConnection> 
  <RouteRule name="default"> 
    <TargetEndpoint>default</TargetEndpoint> 
  </RouteRule> 
</ProxyEndpoint>

Terkadang, Anda mungkin ingin kebijakan dieksekusi setelah beberapa pemrosesan awal lainnya di ProxyEndpoint. Misalnya, Anda ingin memeriksa Kuota di PreFlow, lalu melakukan serangkaian pemrosesan lain setelah Kuota diperiksa, seperti mengonversi permintaan dari JSON ke XML. Untuk melakukannya, lampirkan kebijakan ke jalur permintaan PostFlow. Berikut adalah contoh lampiran PostFlow permintaan. Kebijakan ini akan dieksekusi pada pesan permintaan setelah semua kebijakan di PreFlow (dan alur bersyarat apa pun) dieksekusi.

<PostFlow>
  <Request>
    <Step><Name>JSONtoXMLPolicy</Name></Step>
  </Request>
</PostFlow>

Berikut adalah contoh lampiran PostFlow respons. Kebijakan ini akan dieksekusi pada pesan respons. (PostFlow respons ProxyEndpoint adalah fase pemrosesan akhir sebelum respons ditampilkan ke aplikasi klien yang meminta.)

<PostFlow>
  <Response>
    <Step><Name>XMLtoJSONPolicy</Name></Step>
  </Response>
</PostFlow>