Kebijakan JavaScript

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

Apa

Kebijakan ini memungkinkan Anda menambahkan kode JavaScript kustom yang dijalankan dalam konteks API alur proxy. Di kode JavaScript khusus, Anda bisa menggunakan objek, metode, dan properti dari model objek JavaScript Apigee Edge. Model objek memungkinkan Anda mendapatkan, 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 bisa mendapatkan dan mengatur alur variabel, mengeksekusi logika khusus dan melakukan penanganan kesalahan, mengekstrak data dari permintaan atau mengedit URL target backend secara dinamis, dan masih banyak lagi. Kebijakan ini memungkinkan Anda menerapkan perilaku khusus yang tidak tercakup oleh kebijakan Edge standar lainnya. Faktanya, Anda dapat menggunakan kebijakan JavaScript untuk mencapai banyak perilaku yang sama yang diterapkan oleh kebijakan lainnya, seperti MenetapkanMessage dan ExtractVariable.

Satu kasus penggunaan yang tidak kami rekomendasikan untuk kebijakan JavaScript adalah logging. Kebijakan Logging Pesan lebih cocok untuk logging ke platform {i>logging<i} pihak ketiga seperti Splunk, Sumo, dan Loggly, serta Anda meningkatkan kinerja proxy API dengan menjalankan kebijakan {i>Message Logging<i} di PostClientFlow, yang dijalankan setelah respons dikirim kembali ke klien.

Kebijakan JavaScript memungkinkan Anda menentukan file sumber JavaScript yang akan dieksekusi atau Anda dapat menyertakan kode JavaScript langsung di konfigurasi kebijakan dengan <Source> . Apa pun pilihan Anda, kode JavaScript akan dijalankan saat langkah yang melampirkan kebijakan dijalankan. Untuk opsi {i>source file<i}, kode sumber selalu disimpan dalam lokasi standar dalam paket proxy: apiproxy/resources/jsc. Atau, Anda juga bisa menyimpan kode sumber dalam file sumber daya di tingkat lingkungan atau organisasi. Sebagai lihat petunjuk File resource. Anda dapat upload 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 saat ini didukung.

Video

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

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>

&lt;Javascript&gt; Atribut

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

Atribut berikut khusus untuk kebijakan ini.

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

&lt;DisplayName&gt; elemen

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

<DisplayName>Policy Display Name</DisplayName>

&lt;IncludeURL&gt; elemen

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

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

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

Contoh

Lihat Contoh Dasar di bagian Sampel.

&lt;Property&gt; elemen

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

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

Atribut

Contoh

Lihat contoh di bagian Contoh.

&lt;ResourceURL&gt; elemen

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

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

Contoh

Lihat Contoh Dasar di bagian Sampel.

&lt;Source&gt; elemen

Memungkinkan Anda menyisipkan JavaScript langsung ke konfigurasi XML kebijakan. Elemen yang disisipkan Kode JavaScript dijalankan saat kebijakan dieksekusi dalam 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>

&lt;SSLInfo&gt; elemen

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 konfigurasi TLS untuk klien HTTP adalah proses yang sama dengan yang Anda gunakan untuk mengkonfigurasi TLS untuk TargetEndpoint/TargetServer. Lihat Mengonfigurasi TLS dari Edge ke backend untuk informasi selengkapnya.

Catatan penggunaan

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

Proses debug kode kebijakan JavaScript

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

Untuk melihat pernyataan cetak di Trace:

1. Buka Alat Pelacakan dan mulai sesi pelacakan untuk proxy yang berisi JavaScript Anda lebih lanjut.
2. Panggil proxy.
3. Di Alat Rekaman Aktivitas, klik Output dari semua Transaksi untuk membuka output .

   

4. Pernyataan cetak Anda akan muncul di panel ini.

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

Variabel Alur

Kebijakan ini tidak mengisi variabel apa pun secara default; Namun, Anda dapat mengatur (dan mendapatkan) alur variabel dalam kode JavaScript Anda dengan memanggil metode pada objek konteks. Pola umum 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

This section describes the fault codes and error messages that are returned and fault variables that are set by Edge when this policy triggers an error. This information is important to know if you are developing fault rules to handle faults. To learn more, see What you need to know about policy errors and Handling faults.

Runtime errors

These errors can occur when the policy executes.

Deployment errors

These errors can occur when you deploy a proxy containing this policy.

Fault variables

These variables are set when this policy triggers an error at runtime. For more information, see What you need to know about policy errors.

Example error response

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

Example fault rule

<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 Pemrograman API menggunakan proxy dengan JavaScript.

Artikel Komunitas Apigee

Anda dapat menemukan artikel terkait ini di Apigee Komunitas:

• Bagaimana cara menangani header multi-nilai dalam JavaScript?