자바스크립트 정책

<ph type="x-smartling-placeholder"></ph> 현재 Apigee Edge 문서를 보고 있습니다.
Apigee X 문서. 정보

대상

이 정책을 사용하면 API 프록시 흐름의 컨텍스트 내에서 실행되는 커스텀 자바스크립트 코드를 추가할 수 있습니다. 맞춤 자바스크립트 코드에서는 Apigee Edge JavaScript 객체 모델. 객체 모델을 사용하면 프록시 흐름 컨텍스트에서 변수를 가져오고 설정하고 삭제할 수 있습니다. 객체 모델과 함께 제공되는 기본 암호화 함수를 사용할 수도 있습니다.

정보

자바스크립트 정책에 대한 많은 사용 사례가 있습니다. 예를 들어 흐름 변수를 가져오고 설정하고 맞춤 로직을 실행하고 요청 또는 응답에서 데이터를 추출하고 백엔드 대상 URL을 동적으로 수정하는 등의 작업을 수행할 수 있습니다. 이 정책을 사용하면 다른 표준 Edge 정책에서 다루지 않는 커스텀 동작을 구현합니다. 실제로 자바스크립트 정책을 사용하면 다른 정책에 의해 구현된 동일한 동작을 다수 수행할 수 있습니다(예를 들어 AssignMessage 및 ExtractVariable).

자바스크립트 정책에 권장되지 않는 한 가지 사용 사례는 로깅입니다. 메시지 로깅 정책은 Splunk, Sumo, Loggly와 같은 서드 파티 로깅 플랫폼에 로깅하는 데 더 적합하며 PostClientFlow에서 메시지 로깅 정책을 실행하여 API 프록시 성능을 개선합니다. 이는 응답이 클라이언트로 다시 전송된 후에 실행됩니다.

자바스크립트 정책을 사용하면 실행할 자바스크립트 소스 파일을 지정하거나 <Source> 요소를 사용하여 정책 구성에 자바스크립트 코드를 직접 포함할 수 있습니다. 어떤 경우든 자바스크립트 코드는 정책이 연결된 단계가 실행될 때 실행됩니다. 소스 파일 옵션의 경우 소스 코드는 항상 프록시 번들의 표준 위치(apiproxy/resources/jsc)에 저장됩니다. 환경 또는 조직 수준에서 리소스 파일에 소스 코드를 저장할 수도 있습니다. 자세한 내용은 리소스 파일을 참조하세요. Apigee UI 프록시 편집기를 통해 자바스크립트를 업로드할 수도 있습니다.

자바스크립트 소스 파일에는 항상 .js 확장자가 있어야 합니다.

지원되는 소프트웨어 및 지원되는 버전을 참고하세요. 를 참조하세요.

동영상

자바스크립트 정책을 사용하여 맞춤 정책 확장 프로그램을 만드는 방법을 알아보려면 짧은 동영상을 시청하세요.

샘플

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>

요소 참조

요소 참조는 자바스크립트 정책의 요소 및 속성을 설명합니다.

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

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

다음 속성은 이 정책에만 해당합니다.

다음 표는 모든 정책 상위 요소의 공통 속성에 대해 설명합니다.

<DisplayName> 요소

name 속성 외에도 이 요소를 사용하여 관리 UI 프록시 편집기의 정책에 다른 자연어 이름으로 라벨을 지정합니다.

<DisplayName>Policy Display Name</DisplayName>

<IncludeURL> 요소

<ResourceURL> 또는 <Source> 요소를 사용하여 지정한 기본 자바스크립트 파일에 종속 항목으로 로드할 자바스크립트 라이브러리 파일을 지정합니다. 스크립트는 정책에 나열된 순서대로 평가됩니다. 코드에서 자바스크립트 객체 모델의 객체, 메서드, 속성을 사용할 수 있습니다.

추가 <IncludeURL> 요소를 사용하여 자바스크립트 종속 항목 리소스를 두 개 이상 포함합니다.

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

예

샘플 섹션의 기본 예시를 참조하세요.

<Property> 요소

런타임 시 자바스크립트 코드에서 액세스할 수 있는 속성을 지정합니다.

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

속성

예

샘플 섹션의 예시를 참조하세요.

<ResourceURL> 요소

API 흐름에서 실행할 기본 자바스크립트 파일을 지정합니다. 이 파일은 API 프록시 범위 (API 프록시 번들의 /apiproxy/resources/jsc 아래 또는 또는 조직 또는 리소스 파일에 설명된 대로 여러 API 프록시에서 재사용할 수 있는 환경 범위 코드에서 자바스크립트 객체 모델의 객체, 메서드, 속성을 사용할 수 있습니다.

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

예

샘플 섹션의 기본 예시를 참조하세요.

<Source> 요소

정책의 XML 구성에 자바스크립트를 직접 삽입할 수 있습니다. 삽입된 자바스크립트 코드는 API 흐름에서 정책이 실행될 때 실행됩니다.

예

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

자바스크립트 정책으로 생성되는 모든 HTTP 클라이언트 인스턴스에 TLS를 구성하는 데 사용되는 속성을 지정합니다.

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

HTTP 클라이언트의 TLS를 구성하는 프로세스는 TargetEndpoint/TargetServer에 TLS를 구성하는 프로세스와 동일합니다. Edge에서 백엔드로 TLS 구성을 참조하세요. 를 참조하세요.

사용 참고사항

자바스크립트 정책에는 실제 코드가 없습니다. 대신 자바스크립트 정책은 자바스크립트 '리소스'를 참조하고 자바스크립트가 실행되는 API 흐름의 단계를 정의합니다. 다음과 같은 작업을 할 수 있습니다. 관리 UI 프록시 편집기를 통해 스크립트를 업로드하거나 로컬에서 개발하는 API 프록시의 /resources/jsc 디렉터리

자바스크립트 정책 코드 디버깅

print() 함수를 사용하여 Trace 도구의 트랜잭션 출력 패널에 디버그 정보를 출력합니다. 자세한 내용과 예제는 자바스크립트 print() 문으로 디버그를 참조하세요.

Trace에서 인쇄 문을 보려면 다음 안내를 따르세요.

1. Trace 도구를 열고 자바스크립트 정책이 포함된 프록시의 추적 세션을 시작합니다.
2. 프록시를 호출합니다.
3. Trace 도구에서 모든 트랜잭션의 출력을 클릭하여 출력 패널을 엽니다.

   

4. 인쇄 문이 이 패널에 표시됩니다.

print() 함수를 사용하여 디버그 정보를 Trace 도구에 출력할 수 있습니다. 이 함수는 자바스크립트 객체 모델을 통해 직접 사용할 수 있습니다. 자세한 내용은 'print()로 자바스크립트 디버깅 문'에 추가합니다.

흐름 변수

이 정책은 기본적으로 변수를 입력하지 않습니다. 그러나 컨텍스트 객체의 메서드를 호출하여 자바스크립트 코드에서 흐름 변수를 설정하고 가져올 수 있습니다. 일반적인 패턴은 다음과 같습니다.

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

컨텍스트 객체는 Apigee Edge JavaScript 객체 모델의 일부입니다.

오류 참조

이 섹션에서는 반환되는 오류 코드 및 오류 메시지와 오류 변수를 설명합니다. 이 정책이 오류를 트리거할 때 Edge에서 설정되는 값 오류를 처리하기 위해 오류 규칙을 개발 중인 경우, 이 정보는 중요합니다. 자세한 내용은 정책 오류에 대해 알아야 할 사항 및 오류 처리를 참조하세요.

런타임 오류

이러한 오류는 정책이 실행될 때 발생할 수 있습니다.

배포 오류

이 오류는 이 정책이 포함된 프록시를 배포할 때 발생할 수 있습니다.

오류 변수

이러한 변수는 이 정책이 런타임 시 오류를 트리거할 때 설정됩니다. 자세한 내용은 정책 오류에 대해 알아야 할 사항을 참조하세요.

오류 응답 예시

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

오류 규칙 예시

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

스키마

각 정책 유형은 XML 스키마(.xsd)로 정의됩니다. 참고로 GitHub에서 정책 스키마를 사용할 수 있습니다.

관련 주제

• 자바스크립트 객체 모델
• 안내, 정책 샘플, 자바스크립트 샘플은 자바스크립트를 사용하여 API 프록시 프로그래밍을 참조하세요.

Apigee 커뮤니티 문서

Apigee 커뮤니티에서 관련 자료를 찾아보세요.

• 자바스크립트에서 다중 값 헤더를 처리하는 방법?