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>

Aşağıda, bu politikadaki unsurların kısa bir açıklaması verilmiştir. Bu konuda daha fazla bilgi edinebilirsiniz Mesaj politikası

• <assignMessage name> - Bu politikaya bir ad verir. Adı Politikaya bir akışta referans verildiğinde kullanılır.
• &lt;AssignTo&gt; - GeocodingRequest adlı bir adlandırılmış değişken oluşturur. Bu değişken, web sunucusu tarafından arka uca gönderilecek Hizmet Çağrısı politikası.
• &lt;QueryParams&gt; - arka uç API çağrısı. Bu durumda, Geocoding API'nin konumu bilmesi gerekir. bir posta kodu ve ülke kimliğiyle ifade edilir. Uygulama kullanıcısı bu bilgileri sağlar ve buradan ayıklayabiliriz. sensor parametresi, API için gereklidir ve şu şekildedir: kodunu burada false olarak kodlayıp doğru veya yanlış olarak tanımlayabiliriz.
• &lt;Verb&gt; - Bu örnekte, biz API'ye gidin.
• &lt;AssignVariable&gt;: Bu değişkenler, biz aktarmalısınız. Bu örnekte, değişkenlere daha sonra yanıtta erişilecektir geri dönüyor.

İsteği ServiceCall ile birlikte gönder

Politika oluşturma sırasındaki bir sonraki adım ServiceCallout politikası oluşturmaktır. İlgili içeriği oluşturmak için kullanılan Aşağıda listelenen ServiceÇağrı politikası, Search Console'da oluşturduğumuz istek nesnesini önceki Ataması politikasını Google Geocoding hizmetine gönderir ve sonucu değişkeni kullanabilirsiniz.

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

Aşağıda, bu politikanın unsurlarının kısa bir açıklaması verilmiştir.

• &lt;ServiceCallout&gt; - Önceki politikada olduğu gibi bu politikada da dokunun.
• <İstek değişkeni> - Bu, atamasına dokunun. Arka uç API'sine giden isteği içerir.
• &lt;Response&gt; - Bu öğe, yanıtın depolanır. Göreceğiniz gibi, bu değişkene daha sonra ExtractVariables politikası.
• &lt;HTTPTargetConnection&gt; - Arka ucun hedef URL'sini belirtir API'ye gidin. Bu durumda, API'nin JSON yanıtı döndüreceğini belirtiriz.

Şimdi iki politikamız var. Bunlardan biri, arka uç API'si (Google'ın Geocoding API) ve isteği gerçekten gönderen arka uç API'sini kullanın. Ardından, yanıtı ele alırı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> - Politika adı yine bir akışta kullanıldığında politikaya atıfta bulunmalıdır.
• &lt;Source&gt; - Oluşturduğumuz yanıt değişkenini belirtir Hizmet Çağrısı politikası. Bu politika, verileri ayıklarken bu değişkendir.
• &lt;VariablePrefix&gt; - Değişken öneki, bu politikada oluşturulan diğer değişkenlerdir. Önek, ayrılmış adlar dışında herhangi bir ad olabilir Edge'in Önceden tanımlanmış değişkenler.
• &lt;JSONPayload&gt; - Bu öğe, belirler ve bunu adlandırılmış değişkenlere ekler. Aslında Coğrafi Kodlama API'si, enlem ve boylamdan daha fazla bilgiye sahip olabilir. Ancak, tek ihtiyacımız olan değerler bunlar. açıklayacağım. Geocoding API'nin döndürdüğü JSON oluşturma işleminin tamamını görebilirsiniz. API'nin dokümanlarına göz atın. geometri.location.lat ve geometry.location.lng değerleri, döndürülen JSON nesnesindeki birçok alandan ikisi.

Açıkça anlaşılmayabilir ancak ExtractVariables'in iki farklı değer ürettiğini Adları değişken öneki (coğrafi kod) ve gerçek değişken adları için geçerlidir. Bu değişkenler, ve bu bölüm, aşağıdaki talimatları uygulayarak proxy akışındaki diğer politikalarda bakın. Değişkenler şunlardır:

• geocoderesponse.latitude
• geocoderesponse.longitude

Artık işin büyük bir kısmı tamamlanmış durumda. Bir çerçeve oluşturan üç politikadan oluşan isteği gönderir, arka uç API'sini çağırır ve döndürülen JSON verilerini ayrıştırır. Son adımlarda, akışın bu bölümündeki verileri başka bir Atayan politikasına aktarmazsanız, API (Google Elevation API) gönderir ve birleştirilmiş verilerimizi uygulama geliştiricisine geri gönderir.

<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 incelediğinizde iki sorgu parametresi aldığını göreceksiniz. İlkinin adı locations ve değeri enlem ve boylamdır (virgülle ayrılmış değerler). Diğer parametre sensor. Bu parametre zorunludur ve doğru veya yanlış olmasını sağlayabilirsiniz. Bu noktada unutulmaması gereken en önemli nokta, mesajı için Hizmet Çağrısı gerekmez. İkinciyi çağırmamız gerekmiyor. Proxy'nin kendisinden arka uç API'sini çağırabileceğimiz için bu noktada TargetEndpoint. Bir düşünürseniz, Google Elevations olarak adlandırdığımız tüm verilere sahibiz. API Bu adımda oluşturulan istek mesajı, isteği, ana istek ardışık düzeni için oluşturulur ve böylece ProxyEndpoint'i, bu API proxy'si için yapılandırılan RouteRule'u izleyerek TargetEndpoint'e yönlendirin. TargetEndpoint, uzak API ile olan bağlantıyı yönetir. (Web sitenizin URL'sinin elevation API, TargetEndpoint için HTTPConnection'da tanımlanmıştır. Elevation API'si belgelerine göz atabilirsiniz. Daha önce depoladığımız QueryParams, country ve postalcode artık gerekli olmadığı için bunları kaldırırız burayı tıklayın.

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

Bu noktada, neden başka bir Hizmet Çağrısı politikası oluşturmadığımızı merak ediyor olabilirsiniz. Şu tarihten sonra: başka bir mesaj oluşturduk. Bu mesaj hedefe nasıl gönderilir? Google Elevation API mi? Yanıt <RouteRule> içindedir akış bileşenidir. &lt;RouteRule&gt; <İstek> sonrasında kalan istek mesajlarının ne yapılacağını belirtir şuranın parçası: akış yürütüldü. Bu <RouteRule> tarafından belirtilen TargetEndpoint anlatır Mesajı teslim edecek API proxy'si http://maps.googleapis.com/maps/api/elevation/xml numaralı telefona.

Örnek API proxy'sini indirdiyseniz TargetProxy XML dosyasını dosyada bulabilirsiniz. doc-samples/policy-mashup-cookbook/apiproxy/targets/default.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>

Şimdi sadece Google Elevation API'den gelen yanıtı işlememiz gerekiyor ve tamamlandı.

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

Yanıt, coğrafi olarak kodlanmış konumdaki yükseklikle birleştirilmiş şekilde gösterilir. Veriler de API proxy'sine bağlı politikalarla birleştirilmiş iki arka uç API'sinden alınır ve tek bir yanıtta müşteriye iletilecektir.

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

Özet

Bu tarif defteri konusunda, mashup oluşturmak için politika bileşimi modelinin nasıl kullanılacağı açıklanmaktadır. verileri karşılaştırabilirsiniz. Politika yapısı, API'de yaygın olarak kullanılan bir kalıptır proxy geliştirmeyi öğreneceksiniz.