Langkah 5: Tambahkan kebijakan

Halaman ini berlaku untuk Apigee dan Apigee Hybrid.

Baca dokumentasi Apigee Edge.

Setelah mengubah endpoint target, Anda siap untuk menambahkan kebijakan ke proxy.

Kebijakan adalah komponen Apigee yang dapat Anda lampirkan ke berbagai titik dalam alur pesan melalui proxy API. Kebijakan dapat mengubah format pesan, menerapkan kontrol akses, memanggil layanan jarak jauh, mengizinkan pengguna, memeriksa konten pesan untuk mencari potensi ancaman, dan banyak lagi.

Dalam tutorial ini, Anda akan menambahkan kebijakan XMLtoJSON ke proxy. Kebijakan ini mengonversi payload pesan XML ke JSON. Kode ini juga mengubah header Content-Type respons.

Anda dapat melampirkan kebijakan ke flow di proxy. Alur mengontrol cara kebijakan dijalankan. Dalam contoh ini, Anda akan menambahkan kebijakan ke alur khusus, yang disebut PreFlow. Kebijakan dalam PreFlow, dijalankan sebelum kebijakan lain di dalam proxy. Meskipun Anda tidak perlu memahami alur secara mendetail untuk membaca contoh ini, Anda dapat mempelajarinya lebih lanjut di Mengontrol proxy API dengan flow.

Bacaan Lebih Lanjut

Ada lusinan kebijakan siap pakai yang dapat Anda tambahkan ke {i>proxy<i} Anda, termasuk:

• KebijakanAssignMessage
• Kebijakan RaiseFault
• Kebijakan JavaScript
• Kebijakan SpikeArrest
• Kebijakan ExtractVariables

Untuk mengetahui daftar lengkap kebijakan, lihat Referensi kebijakan.

Catatan: Apigee memperkenalkan versi baru Editor Proxy, yang akan mempermudah pengelolaan proxy.

Petunjuk pada dua tab pertama di bawah menjelaskan cara menggunakan Proxy Editor baru atau Proxy Editor klasik.

Editor Proxy Baru

Ada dua langkah untuk menambahkan kebijakan XMLtoJSON ke proxy Anda:

• Buat instance kebijakan.
• Lampirkan kebijakan ke langkah di PreFlow.

Membuat instance kebijakan

Untuk menggunakan kebijakan, pertama-tama Anda harus membuat instance kebijakan baru dari template kebijakan sebagai berikut:

1. Jika Anda menggunakan https://console.cloud.google.com/apigee: Pilih Pengembangan proxy > Proxy API.

   Jika Anda menggunakan Apigee UI klasik: Pilih Develop > API Proxies dan di panel Proxies, pilih lingkungan untuk proxy.

2. Dari daftar proxy, pilih proxy tempat Anda ingin menambahkan kebijakan.

3. Klik tab Mengembangkan.

4. Di panel kiri, klik tombol + di samping folder Policies.
5. Pada dialog Create policy, pilih Standard policies untuk memfilter daftar kebijakan yang tersedia berdasarkan jenis kebijakan.
6. Di kotak teks Pilih jenis kebijakan, scroll ke bawah ke Mediasi lalu pilih XML Ke JSON.

7. Jika ingin, Anda dapat mengubah Nama dan Nama tampilan kebijakan. Secara default, Apigee menyediakan awalan pendek untuk nama kebijakan. Dalam hal ini, X2J-, Anda dapat menambahkan urutan kata deskriptif yang dipisahkan dengan tanda hubung, setelah awalan. Lihat Konvensi penamaan.

   

   Setelah selesai, klik Buat untuk membuat kebijakan.

Kebijakan XML To JSON kini ditampilkan di panel kanan tampilan Develop:

Paruh bawah panel menampilkan kode XML untuk kebijakan.

Untuk mempelajari kebijakan lebih lanjut, pilih ikon informasi di samping nama kebijakan, lalu klik kebijakan XML To JSON. Tindakan ini akan menampilkan halaman referensi untuk kebijakan.

Catatan: Contoh di atas menggunakan nama kebijakan default X2J-. Lihat Mengubah nama kebijakan untuk mempelajari cara mengubah nama kebijakan.

Mengubah nama kebijakan

Untuk mengubah nama kebijakan:

1. Pilih kebijakan di bagian Policies di panel sebelah kiri.
2. Dalam elemen <DisplayName> dalam kode XML untuk kebijakan tersebut, tambahkan frasa deskriptif untuk kebijakan tersebut, seperti change-xml-to-json, setelah singkatan nama kebijakan:

   

   Tindakan ini akan otomatis memperbarui nama kebijakan, yang ditampilkan di bagian Kebijakan.

   Lihat Konvensi penamaan.

Melampirkan kebijakan ke langkah dalam PreFlow

Setelah membuat kebijakan XML To JSON, Anda dapat melampirkannya ke langkah di PreFlow:

1. Pilih Proxy Endpoints > default > PreFlow di panel sebelah kiri:

   

   Catatan: Anda mungkin perlu meluaskan editor visual di panel sebelah kanan untuk melihat semua elemen. Untuk melakukannya, klik dan tarik pemisah antara editor visual dan editor teks sedikit ke bawah.

2. Klik tombol + di samping PreFlow di panel Response di kanan bawah editor visual:

   

3. Pada dialog Add policy step, pilih kebijakan X2J-change-xml-to-json.

4. Klik Add untuk melampirkan kebijakan.

   Kebijakan X2J-change-xml-to-json kini ditampilkan di panel Response:

   

5. Klik Save untuk menyimpan revisi saat ini dengan perubahan Anda.
6. Untuk men-deploy perubahan ke revisi tersebut, klik Deploy dan ikuti petunjuk di bagian Men-deploy proxy API.

Editor Proxy Klasik

Untuk menambahkan kebijakan XMLtoJSON ke proxy Anda:

1. Buka UI Apigee di browser dan login.
2. Klik API Proxies di jendela utama dan pilih proxy. Untuk contoh ini, pilih proxy yang Anda buat di Langkah 2: Buat proxy API.

3. Klik tab Develop:

   

   Apigee menampilkan API Proxy Editor.

4. Di panel Navigator, klik Proxy Endpoints > default > PreFlow:

   

   Apigee menampilkan editor Flow:

   

   Selain itu, Apigee akan menampilkan konfigurasi Endpoint Proxy default di panel Code:

   <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
   <ProxyEndpoint name="default">
     <Description/>
     <FaultRules/>
     <PreFlow name="PreFlow">
       <Request/>
       <Response/>
     </PreFlow>
     <PostFlow name="PostFlow">
       <Request/>
       <Response/>
     </PostFlow>
     <Flows/>
     <HTTPProxyConnection>
       <BasePath>/myproxy</BasePath>
       <Properties/>
       <VirtualHost>default</VirtualHost>
       <VirtualHost>secure</VirtualHost>
     </HTTPProxyConnection>
     <RouteRule name="default">
       <TargetEndpoint>default</TargetEndpoint>
     </RouteRule>
   </ProxyEndpoint>

5. Untuk menambahkan kebijakan ke proxy Anda, klik tombol + Step di PreFlow respons (bagian bawah editor Flow):

   

   Apigee menampilkan daftar kebijakan yang dikategorikan di kotak dialog Add yang dapat Anda tambahkan ke flow Anda:

   

6. Scroll ke bawah dan pilih kebijakan XMLtoJSON di kategori Mediasi.
   TIPS: API Proxy Editor juga mendukung tarik lalu lepas. Misalnya, setelah menambahkan satu atau beberapa kebijakan ke proxy, Anda kemudian dapat menariknya dari Navigator ke tempatnya di editor Flow:

   

7. Biarkan nama default tersebut, lalu klik Add.

   Apigee melampirkan kebijakan baru ke PreFlow respons:

   

   Perlu diperhatikan bahwa saat Anda mengklik Add, Apigee akan melakukan hal berikut:

   • Menambahkan kebijakan baru di bagian Policies pada panel Navigator.
   • Menambahkan kebijakan XMLtoJSON di panel Flow.
   • Menampilkan XML konfigurasi kebijakan di panel Code.
8. Klik Save untuk menyimpan revisi saat ini dengan perubahan Anda.
9. Untuk men-deploy perubahan, klik tab Overview dan klik tombol Deploy.

Menguji kebijakan baru

Untuk menguji kebijakan baru, jalankan perintah curl berikut di jendela terminal:

curl https://YOUR_ENV_GROUP_HOSTNAME/myproxy

dengan YOUR ENV_GROUP_HOSTNAME adalah nama host grup lingkungan. Lihat Menemukan nama host grup lingkungan.

Lihat Memanggil proxy API untuk informasi selengkapnya.

Atau, Anda dapat membuka URL yang sama di browser.

Anda akan menerima respons berikut:

{
  "root": {
    "city": "San Jose",
    "firstName": "John",
    "lastName": "Doe",
    "state": "CA"
  }
}

Jika isi respons tidak terlihat seperti ini, periksa apakah:

1. Endpoint target Anda adalah https://mocktarget.apigee.net/xml, seperti yang dijelaskan di Langkah 4: Ubah endpoint target Anda:
   • Jika mendapatkan Hello, Guest! sebagai respons, Anda perlu menambahkan /xml ke bagian akhir endpoint target.
   • Jika mendapatkan 404, pastikan Anda mengakses apigee.net, bukan apigee.com.
2. Revisi terbaru proxy Anda telah di-deploy. Coba deploy ulang proxy API Anda seperti yang dijelaskan dalam Men-deploy proxy API dan Membatalkan deployment proxy API.

Untuk melihat header respons dan permintaan HTTP, aktifkan panjang dalam curl dengan opsi -vs (v membuat respons menjadi panjang, tetapi s menyembunyikan beberapa detail yang kurang menarik). Contoh berikut mengasumsikan bahwa proxy diberi nama myproxy:

curl -vs https://YOUR_ENV_GROUP_HOSTNAME/myproxy  | python -m json.tool

Anda akan mendapatkan respons yang terlihat seperti berikut. Perlu diperhatikan bahwa header Content-Type dalam respons adalah application/json. Kebijakan XMLtoJSON mengubah header sebelum mengirim kembali respons.

*   Trying 10.20.30.40...
* TCP_NODELAY set
* Connected to apitest.acme.com (10.20.30.40) port 443 (#0)
...
> GET /myproxy HTTP/1.1
> Host: apitest.acme.com
> User-Agent: curl/7.58.0
> Accept: */*
>
< HTTP/1.1 200 OK
< Date: Fri, 25 May 2018 16:20:00 GMT
< Content-Type: application/json;charset=UTF-8
< Content-Length: 77
< Connection: keep-alive
< X-Powered-By: Apigee
< Access-Control-Allow-Origin: *
...
{ [77 bytes data]
{
  "root": {
    "city": "San Jose",
    "firstName": "John",
    "lastName": "Doe",
    "state": "CA"
  }
}

Langkah berikutnya

Pelajari lebih dalam