Transmettre un proxy à un service SOAP

Dans ce tutoriel, vous allez apprendre à placer un proxy d'API Edge devant un service Web basé sur le protocole SAML.

Ce tutoriel explique comment générer une nouvelle API RESTful devant votre service basé sur le protocole SOAP. Bien qu'il ne soit pas décrit en détail ici, vous pouvez également générer un proxy de type passthrough qui accepte une charge utile SOAP et la transmet au service de backend.

Ce dont vous avez besoin

• Un compte Apigee Edge. Si vous n'en avez pas encore, vous pouvez vous inscrire à l'aide des instructions de la section Créer un compte Apigee Edge.

Créer le proxy

Ici, vous demanderez à Edge de générer le proxy qui se placera devant un service SAML. Il existe deux types de proxys d'API SAML:

• Le type de proxy REST-SOAP-REST génère une nouvelle API RESTful avec une couche de traduction vers le protocole SOAP. Les clients l'appellent comme d'autres services RESTful, en transmettant les paramètres de requête nécessaires au service de backend. Edge traduit cela en la charge utile SOAP attendue par le service.
• Le type de proxy proxy passthrough permet aux clients de transmettre simplement une charge utile SAML. De cette manière, les appels de service SOAP bénéficient des fonctionnalités de gestion en périphérie.

Tester le proxy

Pour tester le proxy que vous avez créé, ouvrez une invite de commande et utilisez cURL. Saisissez la commande ci-dessous, où:

• ORG est le nom de l'organisation Edge dans laquelle vous avez créé le proxy.
• "ENV" est l'environnement dans lequel le proxy est déployé.
• DOMAIN correspond à l'instance Edge que vous utilisez.

curl "https://{ORG}-{ENV}.{DOMAIN}/delayedstockquote/quote?StockSymbol=GOOG&LicenseKey=0"

Par exemple, si votre organisation est docfood, son environnement test et que vous utilisez le cloud d'entreprise Edge, vous devez exécuter une commande semblable à celle-ci:

curl "https://docfood-test.apigee.net/delayedstockquote/quote?StockSymbol=GOOG&LicenseKey=0"

Si vous avez saisi GOOG pour le paramètre de requête StockSymbol, vous devriez obtenir le prix actuel de l'action Alphabet Inc. de classe C. Exemple :

{  
   "GetQuoteResponse":{  
      "GetQuoteResult":{  
         "StockSymbol":"GOOG",
         "LastTradeAmount":819.55,
         "LastTradeDateTime":"2017-02-13T14:33:00",
         "StockChange":5.88,
         "OpenAmount":816.0,
         "DayHigh":820.96,
         "DayLow":815.49,
         "StockVolume":785064,
         "PrevCls":813.67,
         "ChangePercent":"+0.72%",
         "FiftyTwoWeekRange":"663.28 - 841.95",
         "EarnPerShare":27.88,
         "PE":29.4,
         "CompanyName":"Alphabet Inc.",
         "QuoteError":false
      }
   }
}

Obtenir la spécification OpenAPI générée automatiquement

Lorsque vous faites passer un service via un proxy à l'aide de « REST to SOAP to REST », Edge génère automatiquement une spécification OpenAPI. Vous pouvez utiliser la spécification OpenAPI afin de générer la documentation de l'API.

Pour obtenir la spécification OpenAPI, il vous suffit d'accéder à cette URL:

curl https://{ORG}-{ENV}.{DOMAIN}/delayedstockquote/openapi.json

Crédit supplémentaire: comment savoir quels paramètres de ressource, de verbe et de requête utiliser ?

Dans l'appel d'API de test, vous avez utilisé une ressource et des paramètres de requête spécifiques dans votre appel cURL au service SOAP de backend. Mais comment le découvririez-vous par vous-même ?

Ressource et verbe

Dans l'assistant de proxy d'API, lors de la création du proxy, vous avez vu comment les opérations SOAP étaient mappées avec les verbes et les ressources de l'API. Toutefois, si vous ne les avez pas notifiés, voici comment vous en informeriez une fois le proxy créé.

Dans l'onglet Develop (Développer) du proxy d'API, le volet de navigation de gauche contient une liste de flux sous les points de terminaison du proxy. Cliquez sur le flux qui vous intéresse. Par exemple, le flux GetQuote est un bon candidat. Ensuite, affichez le code XML dans le volet "Code", qui indique le chemin d'accès à la ressource et le verbe du flux dans l'élément <Condition> : /quote et GET.

Paramètres de requête

Après avoir sélectionné le flux GetQuote, cliquez sur la première règle de la vue de flux graphique. Il doit s'agir d'une règle d'extraction de variables qui capture les paramètres de requête devant être transmis: StockSymbol et LicenseKey. Si vous recherchez le service SOAP sur le Web, vous y trouverez les éléments à transmettre pour la clé de licence.

Les paramètres de requête capturés sont enregistrés en tant que variables et utilisés par la règle suivante pour créer le message SOAP.