DataPower API Gateway 에서 GatewayScript 및 XSLT 정책의 컨텍스트 변수 사용

모든 API 컨텍스트 변수는 JSON과 유사한 트리에 저장됩니다. 각 컨텍스트 변수는 이 트리에 있는 노드입니다. 리프가 아닌 노드는 오브젝트 또는 배열일 수 있지만 리프 노드는 숫자, 문자열, 부울 또는 문서일 수 있습니다. 문서에는 XML 문서, BLOB, 스트림 또는 다른 JSON 문서가 포함될 수 있습니다.

각 컨텍스트 변수에는 이름과 값이 있습니다. GatewayScript 및 XSLT API를 사용하는 경우 이름으로 컨텍스트 변수에 액세스할 수 있습니다. 점 표기법은 JSON과 유사한 트리에서 해당 노드의 위치를 반영하여 컨텍스트 변수에 액세스하는 데 사용됩니다(예:request.headers.Host). 노드 이름에 특수 문자가 포함되어 있는 경우 대괄호 표기법이 지원됩니다(예: request.headers['Content-Type']).

GatewayScript 정책의 경우 DataPower® API Gateway 에 대한 모든 API가 글로벌 모듈인 context 모듈에 있습니다. 따라서 직접 context 모듈에 액세스할 수 있으며 먼저 require() 함수를 사용할 필요가 없습니다.

XSLT 정책의 경우 API가 http://www.ibm.com/xmlns/datapower/2017/11/apigateway 네임스페이스에 있습니다. 이러한 API를 사용하려면 이 네임스페이스를 선언해야 합니다.

• 컨텍스트 변수 액세스
• 페이로드 정보
• 메시지 헤더 조작
• 메시지 상태 조작 - 예제
• 메시지 본문 액세스
• 세션 거부

컨텍스트 변수 액세스

GatewayScript 예제

client.app.id 컨텍스트 변수를 읽습니다.

var clientID = context.get('client.app.id');

컨텍스트 변수의 값을 설정합니다.

context.set('my.vars.amount', 100);

결과 트리의 구조는 다음과 같습니다.

{ "my": { "vars": { "amount": 100 } } }

my.vars 노드와 이 노드의 모든 하위 노드를 삭제합니다.

context.clear('my.vars');

결과 트리의 구조는 다음과 같습니다.

{ "my": { } }

XSLT 예제

client.app.id 컨텍스트 변수를 읽습니다.

<xsl:variable name="clientID" select="apigw:get-variable('client.app.id')"/>

컨텍스트 변수의 값을 설정합니다.

<apigw:set-variable name="'my.vars.amount'" value="100"/>

결과 트리의 구조는 다음과 같습니다.

{ "my": { "vars": { "amount": 100 } } }

my.vars 노드와 이 노드의 모든 하위 노드를 삭제합니다.

<apigw:clear-variable name="'my.vars'"/>

결과 트리의 구조는 다음과 같습니다.

{ "my": { } }

페이로드 정보

{
  "headers": {
    "Content-Type": "application/xml",
    "X-Client-ID": "1234567890"
  },
  "variables": {
    "amount": 123,
    "name": "xyz"
  },
  "status": {
    "code": 200,
    "reason": "OK"
  },
  "body": <XML/Blob/Stream/JSON Document>
}

메시지 헤더 조작

GatewayScript 예제

헤더를 삭제합니다.

context.message.header.remove('X-My-Header');

헤더를 읽습니다.

var reqType = context.request.header.get('Content-Type');
var currType = context.message.header.get('Content-Type');

헤더를 설정합니다.

context.message.header.set('Content-Type', 'application/json');

헤더를 반복합니다.

var reqHdrs = context.request.headers;
for (var h in reqHdrs) {
   console.log('>>> Reading the request header: ', h, '=', reqHdrs[h]);
} 

var currHdrs = context.message.headers;
for (var h in currHdrs) {
   console.log('>>> Reading the current header: ', h, '=', currHdrs[h]);
} 

headersContext라는 메시지 컨텍스트를 작성하려면, 컨텍스트가 없는 경우 값 true로 HelloWorld라는 부울 컨텍스트 변수에 추가하십시오.

var ctx = context.getMessage("headersContext") || context.createMessage("headersContext");
ctx.setVariable('HelloWorld', true);

setVariable 호출은 변수를 headersContext.variables.HelloWorld로 작성합니다. 후속 switch 정책의 조건문은 headersContext.HelloWorld 대신 headersContext.variables.HelloWorld를 확인해야 합니다.

후속 gatewayscript 정책에서 컨텍스트 변수를 읽으려면, 다음 호출을 사용하십시오.

ctx.getVariable("HelloWorld")

참고: IBM® API Connect Version 5.0또는 DataPower Gateway (v5 compatible)에서 DataPower API Gateway로 API를 마이그레이션하거나 DataPower API Gateway에 대한 새 API를 구성하는 경우 컨텍스트 변수 액세스에 설명된 컨텍스트 변수 메커니즘을 사용하지 않고 메시지 컨텍스트를 작성하는 것이 선호되는 옵션입니다. 마이그레이션의 경우 IBM API Connect Version 5.0의 동작과 가장 밀접하게 일치하며 setVariable 및 getVariable 호출은 수정 없이 계속 작동합니다.

DataPower API Gateway 에 대한 새 API를 작성하는 경우에도 메시지 컨텍스트를 작성하는 것이 선호되는 옵션입니다. 이는 API 컨텍스트를 다양한 기본 DataPower API Gateway 정책이 처리하는 방식과 가장 밀접하게 맞추기 때문입니다.

XSLT 예제

헤더를 삭제합니다.

<apigw:clear-header message="'message'" name="'X-My-Header'"/>

헤더를 읽습니다.

<xsl:variable name="reqType" select="apigw:get-header('request', 'Content-Type')"/>
<xsl:variable name="currType" select="apigw:get-header('message', 'Content-Type')"/>

헤더를 설정합니다.

<apigw:set-header name="'Content-Type'" value="'text/xml'"/>

모든 헤더를 가져옵니다.

<xsl:variable name="allReqHdrs" select="apigw:all-headers('request')"/>
<xsl:variable name="allCurrHdrs" select="apigw:all-headers('message')"/>

메시지 상태 조작 - 예제

메시지 본문 액세스

세션 거부