Créer un proxy d'API à partir d'une spécification OpenAPI

Dans ce tutoriel, vous apprendrez à créer un proxy d'API Edge à partir d'une spécification OpenAPI à l'aide de l'interface utilisateur de gestion Apigee Edge. Lorsque vous appelez le proxy d'API avec un client HTTP, tel que cURL, le proxy d'API envoie la demande au service de simulation cible Apigee.

À propos de l'Open API Initiative

L'Open API Initiative (OAI) se concentre sur la création, l'évolution et la promotion d'un format de description d'API neutre du point de vue du fournisseur, basé sur la spécification Swagger." Pour en savoir plus sur l'Open API Initiative, consultez le site https://openapis.org.

Une spécification OpenAPI utilise un format standard pour décrire une API RESTful. Développées au format JSON ou YAML, les spécifications OpenAPI sont lisibles par une machine, mais sont également faciles à lire et à comprendre pour les humains. La spécification décrit des éléments d'une API, tels que son chemin de base, ses chemins et verbes, en-têtes, paramètres de requête, opérations, types de contenus, modèles de réponse, etc. En outre, une spécification OpenAPI est couramment utilisée pour générer la documentation de l'API.

À propos du service de simulation cible Apigee

Le service de simulation cible Apigee utilisé dans ce tutoriel est hébergé sur Apigee et renvoie des données simples. Il ne nécessite aucune clé d'API ni jeton d'accès. En fait, vous pouvez y accéder dans un navigateur Web. Essayez-le en cliquant sur les éléments suivants :

http://mocktarget.apigee.net

Le service cible renvoie le message d'accueil Hello, guest!.

Pour plus d'informations sur l'ensemble complet des API compatibles avec le service de simulation cible, cliquez sur le lien suivant :

http://mocktarget.apigee.net/help

Prérequis

• Un compte Apigee Edge. Si vous n'avez pas de compte, vous pouvez vous inscrire en suivant les instructions de la section Créer un compte Apigee Edge.
• Une spécification OpenAPI. Dans ce tutoriel, vous allez utiliser la spécification OpenAPI mocktarget.yaml qui décrit le service de simulation d'Apigee, http://mocktarget.apigee.net. Pour en savoir plus, consultez les pages suivantes : https://github.com/apigee/api-platform-samples/tree/master/default-proxies/helloworld/openapi
• cURL installé sur votre machine pour effectuer des appels d'API à partir de la ligne de commande. ou d'un navigateur Web.

Créer le proxy d'API

Félicitations ! Vous avez créé un proxy d'API à partir d'une spécification OpenAPI. Vous allez maintenant le tester pour voir comment cela fonctionne.

Tester le proxy d'API

Vous pouvez tester votre API Mock-Target-API à l'aide de cURL ou d'un navigateur Web.

Dans une fenêtre de terminal, exécutez la commande cURL suivante. Remplacez le nom de votre organisation dans l'URL.

curl http://<org_name>-test.apigee.net/mock-target-api

Réponse

Vous devriez voir la réponse suivante :

Hello, Guest!        

Bravo ! Vous avez créé un proxy d'API simple à partir d'une spécification OpenAPI et l'avez testé.

Ajouter une règle XML vers JSON

Vous allez ensuite ajouter la règle XML à JSON au flux conditionnel View XML Response (Afficher la réponse XML) généré automatiquement lorsque vous avez créé le proxy d'API à partir de la spécification OpenAPI. La règle convertit la réponse XML de la cible en réponse JSON.

Commencez par appeler l'API afin de pouvoir comparer les résultats avec ceux reçus après l'ajout de la règle. Dans une fenêtre de terminal, exécutez la commande cURL suivante. Vous appelez la ressource /xml du service cible, qui renvoie de manière native un bloc XML simple. Remplacez le nom de votre organisation dans l'URL.

curl http://<org_name>-test.apigee.net/mock-target-api/xml

Réponse

La réponse suivante devrait s'afficher :

<root> 
  <city>San Jose</city> 
  <firstName>John</firstName> 
  <lastName>Doe</lastName> 
  <state>CA</state> 
</root>

Essayons maintenant d'effectuer la conversion d'une réponse XML au format JSON. Ajoutez la stratégie XML à JSON au flux conditionnel de réponse XML dans le proxy d'API.

1. Cliquez sur l'onglet Develop (Développer) dans l'angle supérieur droit de la page de présentation de l'API Mock Target dans l'interface utilisateur Edge.
   
2. Dans le volet de navigation de gauche, sous "Proxy Endpoints > Defaults" (Points de terminaison du proxy > Par défaut), cliquez sur le flux conditionnel View XML Response (Afficher la réponse XML).
   
3. Cliquez sur le bouton +Step (+ Étape) inférieur, correspondant à la réponse Response du flux.
   
   La boîte de dialogue "Add Step" ("Ajouter une étape") s'ouvre. Elle contient une liste de toutes les règles que vous pouvez ajouter classées par catégories.
   
4. Faites défiler la page jusqu'à la catégorie "Mediation" (Médiation), puis sélectionnez XML à JSON (XML vers Json).
   
5. Conservez les valeurs par défaut pour Display Name (Nom à afficher) et Name (Nom).
6. Cliquez sur Ajouter. La règle XML vers JSON est appliquée à la réponse.
7. Cliquez sur Enregistrer.

Maintenant que vous avez ajouté la règle, appelez à nouveau l'API à l'aide de cURL. Notez que vous appelez toujours la même ressource /xml. Le service cible renvoie toujours son bloc de code XML, mais la règle du proxy d'API convertit désormais la réponse au format JSON. Effectuez l'appel suivant :

curl http://<org_name>-test.apigee.net/mock-target-api/xml

Notez que la réponse XML est convertie au format JSON :

{"root":{"city":"San Jose","firstName":"John","lastName":"Doe","state":"CA"}}

Félicitations ! Vous avez réussi à tester l'exécution d'une règle ajoutée à un flux conditionnel.