Tutoriel : Création d'une définition d'API REST de proxy

Ce tutoriel explique comment créer et implémenter une définition d'API REST qui donne accès, via un proxy, à un service existant.

A propos de ce tutoriel

Dans ce tutoriel, vous allez suivre les leçons suivantes :

Avant de commencer

Note : Le catalogue Sandbox doit être configuré pour utiliser soit DataPower® API Gateway, soit DataPower Gateway (v5 compatible), soit les deux. Pour plus d'informations, voir Création et configuration des catalogues.

Création d'une définition d'API REST

Vous pouvez créer et définir une API REST qui renvoie les détails de l'agence d'une banque fictive, appelée BankA en suivant les étapes suivantes.

Connectez-vous à API Manager.
Sur la page d'accueil, dans le panneau de gauche, cliquez sur l'icône Développer ou sur la tuile Développer les API et les produits, comme le montre l'image suivante.
Dans l'écran Développer, cliquez sur Ajouter > API.
Dans l'écran OpenAPI 2.0 sélectionnez l'onglet OpenAPI 2.0 l'onglet
Note : Par défaut, l'onglet OpenAPI 2.0 est sélectionné.
Dans la section Créer, sélectionnez le bouton radio Du service cible.
Cliquez sur Suivant.
Dans l'écran Créer une API à partir d'un service cible, dans la section Info, entrez les valeurs suivantes pour créer une API REST à partir d'un service cible.
1. Dans le champ Titre, saisissez Branches.
  Remarque : Le champ Nom est automatiquement complété par la valeur que vous avez saisie dans le champ Titre. Dans ce cas, le champ Nom est rempli automatiquement avec branches.
2. Laissez le champ Version sur 1.0.0.
  La zone Chemin de base est remplie automatiquement avec /branches.
3. Dans le champ Service cible URL, entrez https://sample-api.us-east-a.apiconnect.automation.ibm.com/bank/branches
4. Cliquez sur Suivant.
Dans la section Sécurisé,
1. Cochez les cases Secure using Client ID et CORS, si elles ne sont pas déjà cochées.
2. Cliquez sur Suivant.
Dans la section Résumé,
1. Assurez-vous que les définitions Generated OpenAPI 2.0 et Applied security sont marquées d'une coche de couleur verte.
  Les coches de couleur verte indiquent que la création de l'API a réussi.
2. Cliquez sur Editer l'API pour continuer à configurer l'API.
Dans le nouvel écran, sélectionnez l'onglet Conception, si ce n'est pas déjà fait.
Dans le panneau gauche de l'écran Design view, cliquez sur l'icône + à côté deDefinitions.
Dans la boîte de dialogue Ajouter un schéma,
1. Dans le champ Nom du schéma (clé), entrez address.
2. Dans la liste déroulante Type, sélectionnez object.
3. Cliquez sur Ajouter.
  La boîte de dialogue Ajouter un schéma est maintenant fermée. Dans le panneau de droite de l'écran Design view, la section adresse est affichée.
4. Sous la section adresse, dans le champ Description, entrez The format of the address object.
5. Dans le coin supérieur droit, cliquez sur Enregistrer.
Le schéma du nouvel objet, l' adresse, est désormais affiché dans la section Définitions.
Pour créer des propriétés pour le nouvel objet, adresse,
1. Dans la section Définitions, sélectionnez l' adresse.
  La section des adresses s 'affiche dans le panneau de droite.
2. Dans la section Adresse, cliquez sur Ajouter.
  La boîte de dialogue Ajouter une nouvelle propriété s'affiche.
Pour configurer les propriétés, dans la boîte de dialogue Ajouter une nouvelle propriété, entrez les valeurs suivantes.
1. Dans le champ Nom, saisissez street1.
2. Dans la liste déroulante Type, sélectionnez string.
3. Dans le champ Description, ajoutez The first line of the address.
4. Cliquez sur Sauvegarder.
  La nouvelle propriété de schéma est créée et s'affiche dans Définitions > adresse > Propriétés.
5. Pour terminer la configuration des propriétés, cliquez sur l'icône Options (trois points) à côté de street1 puis sélectionnez Détails.
  La boîte de dialogue Afficher les détails de street1 s'affiche.
6. Dans la boîte de dialogue Afficher les détails de street1, procédez comme suit.
  1. Cliquez sur l'onglet Documentation.
  2. Dans le champ Valeur de l'exemple, entrez 4660 La Jolla Village Drive.
  3. Cliquez sur Sauvegarder.

Pour créer d'autres propriétés de schéma, répétez l'étape 14 et entrez les valeurs fournies dans le tableau 1.

Tableau 1. Adresse des propriétés
Nom de schéma (clé)	TYPE	DESCRIPTION	Exemple de valeur
`street2`	`string`	`The second line of the address`	`Suite 300`
`city`	`string`	`The city of the address`	`San Diego`
`state`	`string`	`The state of the address`	`CA`
`zip_code`	`string`	`The zip code of the address`	`92122`

Note : Les développeurs peuvent trouver les définitions des schémas dans le portail des développeurs. Ces définitions de schéma contiennent des informations sur le type de données que les développeurs attendent dans leurs réponses.

Pour créer un deuxième schéma de définition, répétez les étapes 11 et 12.
Par exemple, créez un nouveau schéma de définition appelé branch.

Pour configurer les propriétés de branch, répétez les étapes 13 et 14 et entrez les valeurs indiquées dans le tableau 2.

Remarque : Pour ajouter et accéder à la valeur Exemple de la définition de schéma que vous avez créée, vous devez terminer le processus en cliquant sur Enregistrer.

Tableau 2. Propriétés de branche
Nom de schéma (clé)	TYPE	DESCRIPTION	Exemple de valeur
`address`	`address`	`The address of the branch`
`type`	`string`	`The type of branch`	`atm`
`id`	`string`	`The ID of the branch`	`9d72ece0-7e7b-11e5-9038-55f9f9c08c06`

Notez que, pour la propriété address, la section type fait référence à la définition que vous avez créée dans votre API, et la section exemple est vide. En suivant ce processus, vous pouvez créer des structures de données complexes.

Définition de la branche

Pour ajouter un nouveau chemin, dans le panneau gauche de l'écran Design view, cliquez sur l'icône + à côté de Chemins.
Dans la boîte de dialogue Ajouter un schéma, procédez comme suit.
1. Dans le champ Chemin, entrez /details.
2. Cliquez sur Ajouter.
Le nouveau chemin appelé /details apparaît dans la liste des chemins disponibles.
Dans Chemins > /détails, cliquez sur l'icône + à côté de Opérations
Dans la boîte de dialogue Ajouter un schéma, procédez comme suit.
1. Dans la liste déroulante Verbe, sélectionnez Obtenir.
2. Cliquez sur Ajouter.
La section GET est affichée dans le panneau de droite de l'écran Design view.
Cliquez sur Enregistrer dans le panneau de droite de l'écran Design view.
Pour modifier l'opération GET dans le chemin d'accès, cliquez sur /details.
Pour modifier l'opération GET dans la trajectoire, dans le panneau gauche de l'écran Design view, sous Paths > Operations, cliquez sur GET.
Dans le panneau de droite, dans la section GET, faites défiler vers le bas jusqu'à la section Réponses.
Pour modifier la réponse, procédez comme suit.
1. Cliquez sur l'icône Options (trois points) à côté de 200, puis sélectionnez Modifier.
  Une section nommée 200 est affichée dans le panneau de droite de l'écran Design.
2. Dans la section 200, procédez comme suit.
  1. Dans le champ Nom (clé), entrez 200.
  2. Dans le champ Description, saisissez 200 OK.
  3. Cliquez sur Sauvegarder.

L'API est désormais en ligne et disponible, vous pouvez donc la tester.

Test de l'API REST

Remarque : en raison des restrictions liées au partage des ressources entre pays d'origine (CORS), l'outil de test d'assemblage ne peut pas être utilisé avec les navigateurs Chrome ou Safari sur la plateforme macOS Catalina.

Avant de commencer

Configurez le service de passerelle avant de tester l'API REST.

Pour tester l'API REST, procédez comme suit.

Sur la page Développer, cliquez sur l'icône Menu (trois points), à côté de l'API, puis cliquez sur Modifier l'API.
Cliquez sur l'onglet Test.
Cliquez sur Configuration de la cible.
La boîte de dialogue Préférences s'affiche.
Dans la boîte de dialogue Préférences, effectuez les tâches suivantes.
1. Réglez l'option Publication automatique sur Activé.
2. Pour définir une limite de taux de produit cible, effectuez les tâches suivantes.
  1. Cliquez sur le bouton Editer.
  2. Dans la boîte de dialogue Choisir une limite de taux, sélectionnez la case d'option Personnaliser.
  3. Dans la zone de texte Nombre d'appels, entrez 5.
  4. Dans la liste déroulante Par, sélectionnez l' heure.
  5. Cliquez sur Choose Rate Limit.
3. Dans la boîte de dialogue Préférences, cliquez sur Enregistrer les préférences.
Cliquez sur Développer en haut de la page.
Sur la page Développer, cliquez sur l'icône Menu (trois points), à côté de l'API que vous souhaitez modifier, puis cliquez sur Modifier l'API.
Cliquez sur l'onglet Test.
Dans la bannière de la page de test, assurez-vous que l'API est en ligne.
Pour exécuter un appel API, cliquez sur Envoyer dans la section Demande.
Cela permet de tester l'API. La réponse affiche le code d'état que vous avez défini (200) et les données de l'agence bancaire que l'API a récupérées.
Cliquez sur Envoyer au moins 5 fois de plus afin de dépasser la limite de débit définie. La réponse renvoie maintenant le code de statut 429 "Trop de demandes" pour indiquer que vous avez dépassé la limite de débit.

Tâches exécutées dans ce tutoriel

Dans ce tutoriel, vous avez effectué les activités suivantes :

Vous avez créé une définition d'API REST.
Vous avez testé l'API REST.