JavaScript politikası

Apigee Edge belgelerini görüntülüyorsunuz.
. Git: Apigee X belgeleri. bilgi

Ne?

Bu politika, bir API bağlamında yürütülen özel JavaScript kodu eklemenize olanak tanır akış şeklinde ifade edilir. Özel JavaScript kodunuzda Apigee Edge JavaScript nesne modeli. Nesne modeli, nesnel modelle ilgili nesnel değişkenlerini ifade eder. Siz da nesne modeliyle sağlanan temel şifreleme işlevlerini de kullanabilir.

Hakkında

JavaScript politikasının pek çok kullanım alanı vardır. Örneğin, zaman çizelgesiyle ilgili bilgileri özel mantık yürütme, hata işleme, isteklerden verileri ayıklama ve yanıt verebilir, arka uç hedef URL'sini dinamik olarak düzenleyebilir ve çok daha fazlasını yapabilirsiniz. Bu politika şunları yapmanıza olanak tanır: diğer standart Edge politikaları kapsamında olmayan özel davranışlar uygulayabilirsiniz. Aslında Diğer politikalar tarafından uygulanan davranışların birçoğunu elde etmek için bir JavaScript politikası kullanabilir. özel bir kod oluşturun.

JavaScript politikasının günlüğe kaydedilmesi için önermediğimiz bir kullanım alanıdır. Message Logging politikası ve Splunk, Sumo ve Loggly gibi üçüncü taraf günlük kaydı platformlarına daha uygundur. PostClientFlow'da Message Logging politikasını çalıştırarak API proxy'sinin performansını iyileştirebilirsiniz yanıt, istemciye geri gönderildikten sonra yürütülür.

JavaScript politikası, yürütülecek bir JavaScript kaynak dosyası veya JavaScript kodunu, <Source> ile doğrudan politikanın yapılandırmasına ekleyebilirsiniz. öğesine dokunun. Her iki durumda da JavaScript kodu, politikanın eklendiği adım yürütüldüğünde yürütülür. Kaynak dosya seçeneğinde, kaynak kodu her zaman proxy paketindeki standart konum: apiproxy/resources/jsc. İsterseniz kaynak kodunu ortam veya kuruluş düzeyinde bir kaynak dosyasında depolamanız gerekir. Örneğin, Kaynak dosyaları başlıklı makaleyi inceleyin. Şunları yapabilirsiniz: JavaScript'inizi Apigee kullanıcı arayüzü proxy düzenleyicisi aracılığıyla da yükleyebilirsiniz.

JavaScript kaynak dosyalarının her zaman .js uzantısı olmalıdır.

Desteklenen yazılımlar ve desteklenen sürümler başlıklı makaleyi inceleyin. sürümünü kullanın.

Video

JavaScript kullanarak özel politika uzantılarının nasıl oluşturulacağını öğrenmek için kısa bir video izleyin politikası.

Örnekler

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>

Öğe referansı

Öğe referansı, JavaScript politikasının öğelerini ve özelliklerini açıklar.

<?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>

<Javascript> Öznitelikler

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

Aşağıdaki özellikler bu politikaya özeldir.

Aşağıdaki tabloda tüm politika üst öğelerinde ortak olan özellikler açıklanmaktadır:

<DisplayName> öğe

Politikayı name özelliğine ek olarak farklı bir doğal dil adına sahip yönetim arayüzü proxy düzenleyicisi.

<DisplayName>Policy Display Name</DisplayName>

<IncludeURL> öğe

Ana JavaScript dosyasına bağımlılık olarak yüklenecek bir JavaScript kitaplık dosyasını belirtir <ResourceURL> veya <Source> öğesiyle belirtilir. Komut dosyaları politikada listelenme sırası. Kodunuz, nesne, yöntemler ve JavaScript nesne modelinin özelliklerini kullanın.

Ek özelliklere sahip birden fazla JavaScript bağımlılık kaynağı dahil <IncludeURL> öğeleri.

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

Örnek

Sana Özel bölümündeki Temel Örneği inceleyin.

<Property> öğe

Çalışma zamanında JavaScript kodundan erişebileceğiniz bir özelliği belirtir.

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

Özellikler

Örnek

Sana Özel bölümündeki örneğe bakın.

<ResourceURL> öğe

API akışında yürütülecek ana JavaScript dosyasını belirtir. Bu dosyayı depolayabilirsiniz API proxy kapsamında (API proxy paketinde /apiproxy/resources/jsc altında veya API proxy düzenleyicisinin Gezinme bölmesinin Komut Dosyaları bölümünde) veya kuruluşunuzda ya da ortam kapsamlarının birden çok API proxy'sinde yeniden kullanılabilmesi için Kaynak dosyaları başlıklı makaleye bakın. Kodunuz nesneleri, JavaScript nesne modelinin yöntemlerini ve özelliklerini öğrenin.

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

Örnek

Sana Özel bölümündeki Temel Örneği inceleyin.

<Source> öğe

Doğrudan politikanın XML yapılandırmasına JavaScript eklemenize olanak tanır. Eklenen Politika, API akışında yürütüldüğünde JavaScript kodu yürütülür.

Örnek

<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>

<SSLInfo> öğe

JavaScript politikası.

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

HTTP istemcisi için TLS'yi yapılandırma işlemi, HTTP istemcilerini yapılandırmak için kullandığınız süreçle aynıdır. TargetEndpoint/TargetServer için TLS. Uçtan arka uca TLS'yi yapılandırma bölümüne bakın konulu videomuzu izleyin.

Kullanım notları

JavaScript politikaları gerçek bir kod içermez. Bunun yerine bir JavaScript politikası, JavaScript "kaynak" ve JavaScript'in yürütüleceği API akışındaki Adımı tanımlar. Şunları yapabilirsiniz: komut dosyanızı Yönetim Arayüzü proxy düzenleyicisi yoluyla yükleyebilir veya Yerel olarak geliştirdiğiniz API proxy'lerindeki /resources/jsc dizini.

JavaScript politika kodunda hata ayıklama

İşleme hata ayıklama bilgilerinin çıkışını almak için print() işlevini kullanın Çıktı panelini kontrol edin. Ayrıntılar ve örnekler için JavaScript ile hata ayıklama bölümüne bakın print() ifadeleri.

Yazdırma özetlerini Trace'te görüntülemek için:

1. İzleme Aracı'nı açın ve JavaScript'inizi içeren bir proxy için izleme oturumu başlatın politikası.
2. Proxy'yi çağırın.
3. İzleme Aracı'nda, çıkışı açmak için Exit from all İşlemler'i tıklayın kontrol edebilirsiniz.

   

4. Basılı ekstreleriniz bu panelde görünür.

İzleme aracına hata ayıklama bilgilerinin çıkışını almak için Print() işlevini kullanabilirsiniz. Bu işlev doğrudan JavaScript nesne modeli aracılığıyla uygulanabilir. Ayrıntılar için "Print() ile JavaScript hatalarını ayıklama" bölümüne bakın özetleri".

Akış Değişkenleri

Bu politika varsayılan olarak hiçbir değişkeni doldurmaz; ancak zaman içindeki akışı ayarlayabilir (ve değişkenlerinin JavaScript kodunuzda nasıl genişleyebilir? Tipik bir desen şöyle görünür:

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

Bağlam nesnesi, Apigee Edge JavaScript nesne modelinin bir parçasıdır.

Hata referansı

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>

Şema

Her politika türü bir XML şemasıyla (.xsd) tanımlanır. Referans olması amacıyla politika şemaları GitHub'da bulabilirsiniz.

İlgili konular

• JavaScript nesne modeli
• Talimatlar, politika örnekleri ve JavaScript örnekleri için bkz. Programlama API'si proxy'leri oluşturun.

Apigee Topluluğu makaleleri

Bu ilgili makaleleri Apigee'de bulabilirsiniz. Topluluk:

• JavaScript'te birden çok değerli üstbilgiler nasıl kullanılır?