정책 구성 사용

<AssignMessage name="GenerateGeocodingRequest">
  <AssignTo createNew="true" type="request">GeocodingRequest</AssignTo>
  <Set>
    <QueryParams>
      <QueryParam name="address">{request.queryparam.postalcode}</QueryParam>
      <QueryParam name="region">{request.queryparam.country}</QueryParam>
      <QueryParam name="sensor">false</QueryParam>
    </QueryParams>
    <Verb>GET</Verb>
  </Set>
  <!-- Set variables for use in the final response -->
  <AssignVariable>
    <Name>PostalCode</Name>
    <Ref>request.queryparam.postalcode</Ref>
  </AssignVariable>
  <AssignVariable>
    <Name>Country</Name>
    <Ref>request.queryparam.country</Ref>
  </AssignVariable>
</AssignMessage>

다음은 이 정책의 요소에 대한 간략한 설명입니다. 이 정책에 대한 자세한 내용은 메시지 할당 정책을 참고하세요.

• <AssignMessage name> - 이 정책에 이름을 지정합니다. 이 이름은 정책이 흐름에서 참조될 때 사용됩니다.
• <AssignTo> - GeocodingRequest라는 이름이 지정된 변수를 만듭니다. 이 변수는 Service콜 정책을 통해 백엔드로 전송될 요청 객체를 캡슐화합니다.
• <QueryParams> - 백엔드 API 호출에 필요한 쿼리 매개변수를 설정합니다. 이 경우 Geocoding API는 우편번호와 국가 ID로 표현되는 위치를 알아야 합니다. 앱 사용자가 이 정보를 제공하면 Google은 여기에서 정보를 추출합니다. sensor 매개변수는 API에 필요하며 true 또는 false입니다. 여기서는 이를 false로 하드코딩합니다.
• <Verb> - 이 경우 API에 간단한 GET 요청을 합니다.
• <AssignVariable> - 이 변수는 API에 전달되는 값을 저장합니다. 이 예시에서 변수에는 나중에 클라이언트에 반환되는 응답에서 액세스됩니다.

ServiceCall을 사용하여 요청 보내기

정책 구성 순서의 다음 단계는 ServiceCallout 정책을 만드는 것입니다. 아래에 나열된 ServiceCall 정책은 이전AssignMessage 정책에서 만든 요청 객체를 Google 지오코딩 서비스에 전송하고 결과를 GeocodingResponse라는 변수에 저장합니다.

<ServiceCallout name="ExecuteGeocodingRequest">
  <Request variable="GeocodingRequest"/>
  <Response>GeocodingResponse</Response>
  <HTTPTargetConnection>
    <URL>http://maps.googleapis.com/maps/api/geocode/json</URL>
  </HTTPTargetConnection>
</ServiceCallout>

다음은 이 정책의 요소에 대한 간략한 설명입니다.

• <ServiceCallout> - 이전 정책과 마찬가지로 이 항목에는 이름이 지정됩니다.
• <Request 변수> -AssignMessage 정책에서 생성된 변수입니다. 백엔드 API로 가는 요청을 캡슐화합니다.
• <Response> - 이 요소는 응답이 저장되는 변수의 이름을 지정합니다. 보시다시피 나중에 ExtractVariables 정책을 통해 이 변수에 액세스합니다.
• <HTTPTargetConnection> - 백엔드 API의 대상 URL을 지정합니다. 여기서는 API가 JSON 응답을 반환하도록 지정합니다.

이제 백엔드 API (Google의 Geocoding API)를 사용하는 데 필요한 요청 정보를 지정하는 정책과 실제로 요청을 백엔드 API로 전송하는 정책이 있습니다. 다음으로 응답을 처리합니다.

<ExtractVariables name="ParseGeocodingResponse">
  <Source>GeocodingResponse</Source>
  <VariablePrefix>geocoderesponse</VariablePrefix>
  <JSONPayload>
    <Variable name="latitude">
       <JSONPath>$.results[0].geometry.location.lat</JSONPath>
    </Variable>
    <Variable name="longitude">
       <JSONPath>$.results[0].geometry.location.lng</JSONPath>
    </Variable>
  </JSONPayload>
</ExtractVariables>

ExtractVariable 정책의 핵심 요소는 다음과 같습니다.

• <ExtractVariables name> - 정책 이름이 흐름에서 사용될 때 정책 이름을 참조하는 데 사용됩니다.
• <Source> - ServiceCall 정책에서 만든 응답 변수를 지정합니다. 이 정책이 데이터를 추출하는 변수입니다.
• <VariablePrefix> - 변수 접두사는 이 정책에 생성된 다른 변수의 네임스페이스를 지정합니다. 프리픽스는 Edge의 사전 정의된 변수에 의해 정의된 예약된 이름을 제외하고 어떤 이름이든 될 수 있습니다.
• <JSONPayload> - 이 요소는 관심 있는 응답 데이터를 검색하여 이름이 지정된 변수에 넣습니다. 실제로 Geocoding API는 위도와 경도보다 훨씬 더 많은 정보를 반환합니다. 하지만 이 샘플에 필요한 유일한 값입니다. API 문서에서 Geocoding API에서 반환된 JSON의 전체 렌더링을 확인할 수 있습니다. delta.location.lat 및 geometry.location.lng 값은 반환된 JSON 객체에 있는 다수의 필드 중 2개에 불과합니다.

명확하지 않을 수 있지만 ExtractVariables가 이름이 변수 프리픽스 (지오코드 응답)와 정책에 지정된 실제 변수 이름으로 구성된 두 개의 변수를 생성하는지 확인하는 것이 중요합니다. 이러한 변수는 API 프록시에 저장되며 아래에서와 같이 프록시 흐름 내의 다른 정책에서 사용할 수 있습니다. 변수는 다음과 같습니다.

• geocoderesponse.latitude
• geocoderesponse.longitude

이제 대부분의 작업이 완료되었습니다. 요청을 형성하고, 백엔드 API를 호출하고, 반환된 JSON 데이터를 파싱하는 세 가지 정책의 복합물을 만들었습니다. 마지막 단계에서는 이 흐름 부분의 데이터를 다른AssignMessage 정책에 피드하고, 두 번째 백엔드 API (Google Elevation API)를 호출하고, 매시된 데이터를 앱 개발자에게 반환합니다.

<AssignMessage name="AssignElevationParameters">
<Remove>
    <QueryParams>
      <QueryParam name="country"/>
      <QueryParam name="postalcode"/>
    </QueryParams>
  </Remove>
  <Set>
    <QueryParams>
      <QueryParam name="locations">{geocoderesponse.latitude},{geocoderesponse.longitude}</QueryParam>
      <QueryParam name="sensor">false</QueryParam>
    </QueryParams>
  </Set>
</AssignMessage>

Google Elevation API를 살펴보면 쿼리 매개변수가 두 개 있음을 알 수 있습니다. 첫 번째는 locations라고 하며 값은 위도와 경도(쉼표로 구분된 값)입니다. 다른 매개변수는 필수인 sensor이며 true 또는 false여야 합니다. 이 시점에서 가장 중요한 점은 여기서 만드는 요청 메시지에 Service콜이 필요 없다는 것입니다. 프록시의 TargetEndpoint에서 백엔드 API를 호출할 수 있기 때문에 지금은 Service콜에서 두 번째 API를 호출할 필요가 없습니다. Google Elevations API를 호출하는 데 필요한 모든 데이터가 갖춰져 있습니다. 이 단계에서 생성된 요청 메시지에는 기본 요청 파이프라인에 대해 생성되는 요청으로 Service콜이 필요하지 않습니다. 따라서 간단하게 ProxyEndpoint에서 이 API 프록시에 대해 구성된 RouteRule에 따라 TargetEndpoint로 전달됩니다. TargetEndpoint는 원격 API를 사용하여 연결을 관리합니다. 고도 API의 URL은 TargetEndpoint의 HTTPConnection에서 정의된다는 점을 떠올려 보세요. Elevation API 문서를 참고하세요. 이전에 저장한 QueryParams(country 및 postalcode)가 더 이상 필요하지 않으므로 여기에서 삭제합니다.

짧은 일시중지: 흐름으로 돌아가기

이 시점에서는 Google에서 다른 Service콜 정책을 만들지 않는 이유가 궁금하실 텐데요. 결국 다른 메시지를 만들었습니다. 이 메시지는 어떻게 타겟인 Google Elevation API로 전송되나요? 답은 흐름의 <RouteRule> 요소에 있습니다. <RouteRule>은 흐름의 <Request> 부분이 실행된 후 남은 요청 메시지로 수행할 작업을 지정합니다. 이 <RouteRule>로 지정된 TargetEndpoint는 메시지를 http://maps.googleapis.com/maps/api/elevation/xml로 전달하도록 API 프록시에 지시합니다.

샘플 API 프록시를 다운로드한 경우 doc-samples/policy-mashup-cookbook/apiproxy/targets/default.xml 파일에서 TargetProxy XML을 찾을 수 있습니다.

<TargetEndpoint name="default">
  <HTTPTargetConnection>
    <!-- This is where we define the target. For this sample we just use a simple URL. -->
    <URL>http://maps.googleapis.com/maps/api/elevation/xml</URL>
  </HTTPTargetConnection>
</TargetEndpoint>

이제 Google Elevation API의 응답을 처리하기만 하면 됩니다.

$ curl "http://{myorg}-test.apigee.net/policy-mashup-cookbook?country=us&postalcode=08008"

응답에는 앱 최종 사용자가 제공하는 우편번호 중심의 지오코딩된 위치와 지오코딩된 위치의 고도가 포함됩니다. 2개의 백엔드 API에서 데이터를 가져와 API 프록시에 연결된 정책과 매시업한 후 단일 응답으로 클라이언트에 반환했습니다.

{  
   "country":"us",
   "postalcode":"08008",
   "elevation":{  
      "meters":0.5045232,
      "feet":1.6552599030345978
   },
   "location":{  
      "latitude":39.75007129999999,
      "longitude":-74.1357407
   }
}

요약

이 설명서 주제에서는 정책 구성 패턴을 사용하여 여러 백엔드 소스에서 데이터의 매시업을 만드는 방법을 설명했습니다. 정책 구성은 API에 광고 소재 기능을 추가하기 위해 API 프록시 개발에 사용되는 일반적인 패턴입니다.