Kebijakan JavaScript

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

Apa

Kebijakan ini memungkinkan Anda menambahkan kode JavaScript kustom yang dieksekusi dalam konteks alur proxy API. Dalam kode JavaScript kustom, Anda dapat menggunakan objek, metode, dan properti dari model objek JavaScript Apigee Edge. Model objek memungkinkan Anda mendapatkan, menetapkan, dan menghapus variabel dalam konteks alur proxy. Anda juga dapat menggunakan fungsi kriptografi dasar yang disediakan bersama model objek.

Tentang

Ada banyak kasus penggunaan untuk kebijakan JavaScript. Misalnya, Anda dapat memperoleh dan menetapkan variabel alur, menjalankan logika kustom dan melakukan penanganan fault, mengekstrak data dari permintaan atau respons, mengedit URL target backend secara dinamis, dan banyak lagi. Kebijakan ini memungkinkan Anda menerapkan perilaku khusus yang tidak tercakup dalam kebijakan Edge standar lainnya. Bahkan, Anda dapat menggunakan kebijakan JavaScript untuk melakukan berbagai perilaku yang sama dengan yang diterapkan oleh kebijakan lain, seperti MenetapkanMessage dan ExtractVariable.

Satu kasus penggunaan yang tidak kami rekomendasikan untuk kebijakan JavaScript adalah logging. Kebijakan Logging Pesan jauh lebih cocok untuk logging ke platform logging pihak ketiga seperti Splunk, Sumo, dan Loggly, dan Anda juga dapat meningkatkan performa proxy API dengan menjalankan kebijakan Message Logging di PostClientFlow, yang dijalankan setelah respons dikirim kembali ke klien.

Kebijakan JavaScript memungkinkan Anda menentukan file sumber JavaScript yang akan dijalankan atau Anda dapat menyertakan kode JavaScript secara langsung dalam konfigurasi kebijakan dengan elemen <Source>. Apa pun itu, kode JavaScript akan dijalankan saat langkah yang terkait dengan kebijakan yang dilampirkan dijalankan. Untuk opsi file sumber, kode sumber selalu disimpan di lokasi standar dalam paket proxy: apiproxy/resources/jsc. Atau, Anda juga dapat menyimpan kode sumber dalam file resource di tingkat lingkungan atau organisasi. Untuk mengetahui petunjuknya, lihat File resource. Anda juga dapat mengupload JavaScript melalui editor proxy UI Apigee.

File sumber JavaScript harus selalu memiliki ekstensi .js.

Lihat Software yang didukung dan versi yang didukung untuk versi JavaScript yang didukung saat ini.

Video

Tonton video singkat untuk mempelajari cara membuat ekstensi kebijakan kustom menggunakan kebijakan JavaScript.

Contoh

curl -i -H 'Content-Type: application/x-www-form-urlencoded' -X POST -d 'user=Will' http://myorg-test.apigee.net/js-example

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Javascript async="false" continueOnError="false" enabled="true" timeLimit="200" name="target-rewrite">
    <DisplayName>target-rewrite</DisplayName>
    <Properties/>
    <ResourceURL>jsc://js-example.js</ResourceURL>
</Javascript>

Referensi elemen

Referensi elemen menjelaskan elemen dan atribut kebijakan JavaScript.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Javascript async="false" 
        continueOnError="false" enabled="true" timeLimit="200" 
        name="JavaScript-1">
    <DisplayName>JavaScript 1</DisplayName>
    <Properties>
        <Property name="propName">propertyValue</Property>
    </Properties>
    <SSLInfo>
        <Enabled>trueFalse</Enabled>
        <ClientAuthEnabled>trueFalse</ClientAuthEnabled>
        <KeyStore>ref://keystoreRef</KeyStore>
        <KeyAlias>keyAlias</KeyAlias>
        <TrustStore>ref://truststoreRef</TrustStore>
    </SSLInfo>
    <IncludeURL>jsc://a-javascript-library-file</IncludeURL>
    <ResourceURL>jsc://my-javascript-source-file</ResourceURL>
    <Source>insert_js_code_here</Source>

</Javascript>

Atribut <JavaScript>

<Javascript name="Javascript-1" enabled="true" continueOnError="false" async="false" timeLimit="200">

Atribut berikut bersifat khusus untuk kebijakan ini.

Tabel berikut menjelaskan atribut yang sama untuk semua elemen induk kebijakan:

Elemen <DisplayName>

Gunakan selain atribut name untuk memberi label kebijakan di editor proxy UI pengelolaan dengan nama natural-language yang berbeda.

<DisplayName>Policy Display Name</DisplayName>

Elemen <IncludeURL>

Menentukan file library JavaScript yang akan dimuat sebagai dependensi ke file JavaScript utama yang ditentukan dengan elemen <ResourceURL> atau <Source>. Skrip akan dievaluasi sesuai urutan yang tercantum dalam kebijakan. Kode Anda dapat menggunakan objek, metode, dan properti dari model objek JavaScript.

Sertakan lebih dari satu resource dependensi JavaScript dengan elemen <IncludeURL> tambahan.

<IncludeURL>jsc://my-javascript-dependency.js</IncludeURL>

Contoh

Lihat Contoh Dasar di bagian Contoh.

Elemen <Property>

Menentukan properti yang dapat Anda akses dari kode JavaScript saat runtime.

<Properties>
    <Property name="propName">propertyValue</Property>
</Properties>

Atribut

Contoh

Lihat contohnya di bagian Sample.

Elemen <ResourceURL>

Menentukan file JavaScript utama yang akan dijalankan di alur API. Anda dapat menyimpan file ini di cakupan proxy API (di bagian /apiproxy/resources/jsc di paket proxy API atau di bagian Skrip pada panel Navigator editor proxy API), atau di cakupan organisasi atau lingkungan untuk digunakan kembali di beberapa proxy API, seperti yang dijelaskan dalam File resource. Kode Anda dapat menggunakan objek, metode, dan properti dari model objek JavaScript.

<ResourceURL>jsc://my-javascript.js</ResourceURL>

Contoh

Lihat Contoh Dasar di bagian Contoh.

Elemen <Source>

Memungkinkan Anda menyisipkan JavaScript langsung ke dalam konfigurasi XML kebijakan. Kode JavaScript yang dimasukkan akan dijalankan saat kebijakan dijalankan di alur API.

Contoh

<Javascript name='JS-ParseJsonHeaderFullString' timeLimit='200' >
  <Properties>
    <Property name='inboundHeaderName'>specialheader</Property>
    <Property name='outboundVariableName'>json_stringified</Property>
  </Properties>
  <Source>
var varname = 'request.header.' + properties.inboundHeaderName + '.values.string';
var h = context.getVariable(varname);
if (h) {
  h = JSON.parse(h);
  h.augmented = (new Date()).valueOf();
  var v = JSON.stringify(h, null, 2) + '\n';
  // further indent
  var r = new RegExp('^(\S*)','mg');
  v= v.replace(r,'    $1');
  context.setVariable(properties.outboundVariableName, v);
}
  </Source>
</Javascript>

Elemen <SSLInfo>

Menentukan properti yang digunakan untuk mengonfigurasi TLS untuk semua instance klien HTTP yang dibuat oleh kebijakan JavaScript.

    <SSLInfo>
        <Enabled>trueFalse</Enabled>
        <ClientAuthEnabled>trueFalse</ClientAuthEnabled>
        <KeyStore>ref://keystoreRef</KeyStore>
        <KeyAlias>keyAlias</KeyAlias>
        <TrustStore>ref://truststoreRef</TrustStore>
    </SSLInfo>

Proses mengonfigurasi TLS untuk klien HTTP sama dengan proses yang Anda gunakan untuk mengonfigurasi TLS untuk TargetEndpoint/TargetServer. Lihat Mengonfigurasi TLS dari Edge ke backend untuk mengetahui informasi selengkapnya.

Catatan penggunaan

Kebijakan JavaScript tidak berisi kode yang sebenarnya. Sebagai gantinya, kebijakan JavaScript mereferensikan 'resource' JavaScript dan menentukan Langkah dalam alur API tempat JavaScript dieksekusi. Anda dapat mengupload skrip melalui editor proxy UI Pengelolaan, atau menyertakannya dalam direktori /resources/jsc dalam proxy API yang Anda kembangkan secara lokal.

Proses debug kode kebijakan JavaScript

Gunakan fungsi print() untuk mendapatkan output informasi debug ke panel output transaksi di Trace Tool. Untuk mengetahui detail dan contohnya, lihat Debug dengan pernyataan print() JavaScript.

Untuk melihat pernyataan cetak di Trace:

1. Buka Alat Rekaman Aktivitas dan mulai sesi perekaman aktivitas untuk proxy yang berisi kebijakan JavaScript Anda.
2. Memanggil proxy.
3. Di Alat Rekaman Aktivitas, klik Output dari semua Transaksi untuk membuka panel output.

   

4. Laporan cetak Anda akan muncul di panel ini.

Anda dapat menggunakan fungsi print() untuk mendapatkan output informasi debug ke alat Trace. Fungsi ini tersedia langsung melalui model objek JavaScript. Untuk mengetahui detailnya, lihat "Men-debug JavaScript dengan pernyataan print()".

Variabel Alur

Kebijakan ini tidak mengisi variabel apa pun secara default. Namun, Anda dapat menetapkan (dan mendapatkan) variabel alur dalam kode JavaScript dengan memanggil metode pada objek konteks. Pola umumnya akan terlihat seperti ini:

context.setVariable("response.header.X-Apigee-Target", context.getVariable("target.name"))

Objek konteks adalah bagian dari model objek JavaScript Apigee Edge.

Referensi error

Bagian ini menjelaskan kode kesalahan dan pesan error yang ditampilkan serta variabel kesalahan yang disetel oleh Edge saat kebijakan ini memicu error. Informasi ini penting untuk diketahui apakah Anda mengembangkan aturan fault untuk menangani kesalahan. Untuk mempelajari lebih lanjut, lihat Yang perlu Anda ketahui tentang error kebijakan dan Menangani kesalahan.

Error runtime

Error ini dapat terjadi saat kebijakan dieksekusi.

Error saat deployment

Error ini dapat terjadi saat Anda men-deploy proxy yang berisi kebijakan ini.

Variabel kesalahan

Variabel ini ditetapkan saat kebijakan ini memicu error saat runtime. Untuk informasi selengkapnya, lihat Yang perlu Anda ketahui tentang error kebijakan.

Contoh respons error

{
  "fault": {
    "faultstring": "Execution of SetResponse failed with error: Javascript runtime error: "ReferenceError: "status" is not defined. (setresponse.js:6)\"",
    "detail": {
      "errorcode": "steps.javascript.ScriptExecutionFailed"
    }
  }
}

Contoh aturan kesalahan

<FaultRule name="JavaScript Policy Faults">
    <Step>
        <Name>AM-CustomErrorResponse</Name>
        <Condition>(fault.name Matches "ScriptExecutionFailed") </Condition>
    </Step>
    <Condition>(javascript.JavaScript-1.failed = true) </Condition>
</FaultRule>

Skema

Setiap jenis kebijakan ditentukan oleh skema XML (.xsd). Sebagai referensi, skema kebijakan tersedia di GitHub.

Topik terkait

• Model objek JavaScript
• Untuk petunjuk, contoh kebijakan, dan contoh JavaScript, lihat Proxy API Pemrograman dengan JavaScript.

Artikel Komunitas Apigee

Anda dapat menemukan artikel terkait ini di Komunitas Apigee:

• Bagaimana cara menangani header multinilai dalam JavaScript?