Politika bileşimini kullanma

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

Bu politikadaki öğelerin kısa bir açıklamasını aşağıda bulabilirsiniz. Bu politika hakkında daha fazla bilgiyi Assign Message Policy (Mesaj Atama Politikası) başlıklı makalede bulabilirsiniz.

• <AssignMessage name>: Bu politikaya ad verir. Ad, politikaya bir akışta referans verildiğinde kullanılır.
• <AssignTo>: GeocodingRequest adlı bir değişken oluşturur. Bu değişken, ServiceCallout politikası tarafından arka uca gönderilecek istek nesnesini kapsar.
• <QueryParams>: Arka uç API çağrısı için gereken sorgu parametrelerini ayarlar. Bu durumda, Geocoding API'sinin posta kodu ve ülke koduyla ifade edilen konumu bilmesi gerekir. Bu bilgiler uygulama kullanıcısı tarafından sağlanır ve biz yalnızca bu bilgileri burada ayıklarız. sensor parametresi API tarafından gereklidir ve doğru ya da yanlış değerini alır. Burada bu parametreyi yanlış olarak kodluyoruz.
• <Fiil>: Bu durumda, API'ye basit bir GET isteği gönderiyoruz.
• <AssignVariable>: Bu değişkenler, API'ye ilettiğimiz değerleri depolar. Bu örnekte, değişkenlere daha sonra istemciye döndürülen yanıtta erişilir.

İsteği ServiceCallout ile gönderme

Politika oluşturma sırasındaki bir sonraki adım, ServiceCallout politikası oluşturmaktır. Aşağıda listelenen ServiceCallout politikası, önceki AssignMessage politikasında oluşturduğumuz istek nesnesini Google Geocoding hizmetine gönderir ve sonucu GeocodingResponse adlı bir değişkene kaydeder.

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

Bu politikanın unsurlarının kısa bir açıklamasını aşağıda bulabilirsiniz.

• <ServiceCallout>: Önceki politikada olduğu gibi bu politikada da bir ad vardır.
• <Request variable>: Bu, AssignMessage politikasında oluşturulan değişkendir. Arka uç API'sine giden isteği kapsar.
• <Response>: Bu öğe, yanıtın depolandığı bir değişkeni adlandırır. Gördüğünüz gibi, bu değişkene daha sonra ExtractVariables politikası tarafından erişilecektir.
• <HTTPTargetConnection>: Arka uç API'sinin hedef URL'sini belirtir. Bu durumda, API'nin JSON yanıtı döndürmesini belirtiriz.

Artık iki politikamız var. Bunlardan biri arka uç API'sini (Google'ın Geocoding API'si) kullanmak için gereken istek bilgilerini belirtir. İkincisi ise isteği arka uç API'sine gönderir. Ardından, yanıtı ele alacağız.

<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 politikasının temel öğeleri şunlardır:

• <ExtractVariables name>: Yine, politika adı bir akışta kullanıldığında politikaya referans vermek için kullanılır.
• <Source>: ServiceCallout politikasında oluşturduğumuz yanıt değişkenini belirtir. Bu politika, verileri bu değişkenden çıkarır.
• <VariablePrefix>: Değişken ön eki, bu politikada oluşturulan diğer değişkenler için bir ad alanı belirtir. Önek, Edge'in önceden tanımlanmış değişkenleri tarafından tanımlanan ayrılmış adlar hariç herhangi bir ad olabilir.
• <JSONPayload>: Bu öğe, ilgilendiğimiz yanıt verilerini alır ve bunları adlandırılmış değişkenlere yerleştirir. Aslında, Geocoding API enlem ve boylamdan çok daha fazla bilgi döndürür. Ancak bu örnek için ihtiyacımız olan tek değerler bunlardır. Geocoding API tarafından döndürülen JSON'ın tam bir oluşturulmuş halini API'nin dokümanlarında görebilirsiniz. geometry.location.lat ve geometry.location.lng değerleri, döndürülen JSON nesnesindeki birçok alandan yalnızca ikisidir.

Bu durum açıkça görülmeyebilir ancak ExtractVariables'ın, adları değişken önekinden (geocoderesponse) ve politikada belirtilen gerçek değişken adlarından oluşan iki değişken oluşturduğunu görmek önemlidir. Bu değişkenler API proxy'sinde depolanır ve proxy akışındaki diğer politikalarda kullanılabilir. Değişkenler şunlardır:

• geocoderesponse.latitude
• geocoderesponse.longitude

İşin büyük kısmı tamamlandı. İstek oluşturan, arka uç API'sini çağıran ve döndürülen JSON verilerini ayrıştıran üç politikadan oluşan bir bileşik oluşturduk. Son adımlarda, akışın bu bölümündeki verileri başka bir AssignMessage politikasına aktaracak, ikinci arka uç API'sini (Google Elevation API) çağıracak ve birleştirilmiş verilerimizi uygulama geliştiriciye döndüreceğiz.

<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'yi incelerseniz iki sorgu parametresi aldığını görürsünüz. İlk parametre locations olarak adlandırılır ve değeri enlem ve boylamdır (virgülle ayrılmış değerler). Diğer parametre olan sensor gereklidir ve doğru ya da yanlış olmalıdır. Bu noktada dikkat edilmesi gereken en önemli nokta, burada oluşturduğumuz istek mesajının ServiceCallout gerektirmediğidir. Bu noktada, ikinci API'yi bir ServiceCallout'tan çağırmamız gerekmez. Bunun nedeni, arka uç API'yi proxy'nin TargetEndpoint'inden çağırabilmemizdir. Düşündüğünüzde, Google Elevations API'yi çağırmak için gereken tüm verilere sahibiz. Bu adımda oluşturulan istek mesajı, ana istek ardışık düzeni için oluşturulan istek olduğundan ServiceCallout gerektirmez. Bu nedenle, bu API proxy'si için yapılandırılan RouteRule'u izleyerek ProxyEndpoint tarafından TargetEndpoint'e yönlendirilir. TargetEndpoint, uzak API ile bağlantıyı yönetir. (Yükseltme API'sinin URL'sinin TargetEndpoint için HTTPConnection'da tanımlandığını hatırlayın. Daha fazla bilgi edinmek isterseniz Elevation API belgelerine göz atabilirsiniz. Daha önce depoladığımız QueryParams'ler, country ve postalcode artık gerekli olmadığından bunları buradan kaldırıyoruz.

Kısa duraklama: Akışa geri dönme

Bu noktada, neden başka bir ServiceCallout politikası oluşturmadığımızı merak edebilirsiniz. Sonuçta başka bir mesaj oluşturduk. Bu mesaj, hedef olan Google Elevation API'ye nasıl gönderilir? Yanıt, akışın <RouteRule> öğesinde yer alır. <RouteRule> Akışın <Request> bölümü yürütüldükten sonra kalan istek mesajlarıyla ne yapılacağını belirtir. Bu <RouteRule> tarafından belirtilen TargetEndpoint, API proxy'sine mesajı http://maps.googleapis.com/maps/api/elevation/xml adresine iletmesini söyler.

Örnek API proxy'sini indirdiyseniz TargetProxy XML'sini doc-samples/policy-mashup-cookbook/apiproxy/targets/default.xml dosyasında bulabilirsiniz.

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

Şimdi Google Elevation API'den gelen yanıtı işlememiz gerekiyor. İşlem tamamlandığında işimiz bitecek.

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

Yanıtta, uygulama son kullanıcısı tarafından sağlanan posta kodunun merkezinin coğrafi olarak kodlanmış konumu ve bu coğrafi olarak kodlanmış konumdaki yükseklik bilgisi yer alır. Veriler iki arka uç API'sinden alınmış, API proxy'sine eklenen politikalarla birleştirilmiş ve tek bir yanıtla istemciye döndürülmüştür.

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

Özet

Bu çözüm kitabı konusundaki bilgilerde, birden fazla arka uç kaynağındaki verilerden melez uygulama oluşturmak için politika oluşturma kalıbının nasıl kullanılacağı açıklanmıştır. Politika oluşturma, API'nize yaratıcı işlevler eklemek için API proxy geliştirme sürecinde kullanılan yaygın bir yöntemdir.