Créer, et tester une API via Talend Cloud API Designer et API Tester

Dans ce tutoriel, vous apprenez à créer la définition d’une API depuis Talend Cloud API Designer. Ensuite, vous allez importer et implémenter cette définition d’API dans votre studio Talend. Puis vous allez la tester depuis Talend Cloud API Tester.

Prérequis :

  • Disposer d’un accès à la TMC (Talend Management Console).
  • Disposer des droits : API Designer, API Tester, Operator et Integration Developer.
  • Avoir installé le Studio Talend.

Fichier utilisé dans ce tutoriel :

Composants ETL utilisés dans le traitement :

  • tFileInputDelimited : Pour lire les données à partir d’un fichier csv.
  • tMap : Pour appliquer les transformation et faire du mapping.
  • tWriteJsonFiled : Pour construire un objet JSON.

Composants ESB utilisés dans le traitement :

  • tRESTRequest : Pour recevoir les requêtes GET/POST/PUT/PATCH/DELETE des clients, du côté serveur.
  • tRestResponse : Pour retourner un code de statut HTTP spécifique au client comme réponse et du contenue (JSON, XML, …) à une requête HTTP et/ou HTTPS.

Crée une API via Talend cloud API Designer :

Talend Cloud API Designer facilite deux étapes importantes d’un projet d’API : la définition et la documentation. Dans cette partie vous allez découvrir comment définir une API et comment générer sa documentation via l’interface web API Designer.

Procédure :

  • Dans la page d’accueil sélectionnez API Designer
  • Dans la page d’accueil de Talend Cloud API Designer, cliquez sur Nouvelle API.
  • Sélectionnez Nouvelle API et cliquez sur API vierge afin de concevoir une API de zéro,
  • Saisissez un nom et une version pour votre API.
  • Cliquez sur Créer.

Définissez les informations générales de l’API :

  • Accédez à la page des informations générales, cliquant sur le nom de votre API
  • Cliquez sur l’icône représentant un crayon, à droite de la section INFORMATIONS GÉNÉRALES afin de modifier la version, la description, les informations de contact et de licence, ainsi que les termes du service pour votre API.
  • Modifiez la section TYPES DE MÉDIAS pour ajouter ou supprimer des types de médias.
  • Ajoutez votre (vos) endpoint(s) dans la section ENDPOINTS.
  • Définissez la sécurité de l’API dans les sections SÉCURITÉ GLOBALE et SCHÉMAS DE SÉCURITÉ.

Créer une ressource :

Une ressource est un élément avec lequel interagissent vos consommateur·trices via votre API.

Procédure :

  • Cliquez sur le bouton + dans le coin supérieur droit du panneau de gauche.
  • Cliquez sur Resource.
  • Saisissez un chemin Path pour votre ressource, /getAll par exemple
  • Cliquez sur Sauvegarder.

Créer une opération :

Une opération est l’action qui peut être effectuée sur vos ressources (POST, GET, …).

Procédure :

  • Cliquez sur le bouton + dans le coin supérieur droit du panneau de gauche.
  • Cliquez sur Operation, ou cliquez sur le type d’opération, par exemple GET si vous la créez dans une ressource existante.
  • Saisissez un nom, dans le champ Nom, pour votre opération.
  • Sélectionnez la méthode dans la liste Method et saisissez un chemin dans le champ Chemin d’accès.
  • Cliquez sur Sauvegarder.

Implémenter l’API dans le studio :

Procédure :

  • Dans la vue Repository de la perspective Integration, cliquez-droit sur le nœud REST API Definitions dans le dossier Metadata et sélectionnez Create API definition dans le menu contextuel.
  • Sélectionnez Import from API Designer.
  • Sélectionnez l’API que vous voulez implémenter, dans notre scénario c’est FrenchCodePostal.
  • La définition d’API créée s’affiche sous le nœud Metadata > REST API Definitions, dans la vue Repository.

Une fois que les métadonnées d’API REST sont créées, vous pouvez utiliser le composant tRESTRequest avec des Jobs.

  • Créez un nouveau Job et ajoutez les composant suivant : tFileInputDelimited, tMap, tWriteJsonFiled, tRESTRequest, tRestResponse.
  • Dans la vue Basic settings, de votre composant tRESTRequest, sélectionnez Repository dans la liste Definition.
  • Cliquez sur […] à côté du champ Definition pour afficher l’assistant Repository Content, où les métadonnées d’API REST créées dans le référentiel sont affichées.
  • Sélectionnez depuis les métadonnées une spécification d’API à utiliser dans le composant tRESTRequest et cliquez sur OK.
  • Le champ REST Endpoint, la table REST API Mapping et l’onglet Documentation sont renseignés automatiquement avec les paramètres correspondants.
  • Cliquez-droit sur l’icône du tRESTRequest, cliquez sur Row > getAll, puis cliquez sur l’icône du tMap afin de relier les composants.
  • Reliez votre fichier délimiter qui contient la source des données avec le composant tWriteJsonFiled et configurer ce dernier pour construire le JSON que vous allez le retournez en réponse. La figure ci-dessous montre la configuration du composant
  • Reliez la sortie du tWriteJSONFiled avec votre tMap est configurer votre mapping que le montre la figure ci-dessous
  • Reliez votre sortie du tMap avec votre tRestResponse. Votre flux devra ressembler au suivant :
  • Exécuter votre traitement et allez vers la page d’API Tester

Talend Cloud API Tester vous permet d’appeler n’importe quel type d’API HTTP (REST, hypermedia, SOAP, OData, etc.) à l’aide d’un éditeur de requêtes puissant et facile à utiliser.

  • Choisissez votre opération et envoyez votre requête.
  • La réponse de votre requête devra ressembler à la suivante :

Vous savez désormais comment Créer, et tester une API via Talend Cloud API Designer et API Tester.

Laisser un commentaire

Votre adresse de messagerie ne sera pas publiée. Les champs obligatoires sont indiqués avec *