Propriétés du cREST Standard

API definition

Cliquez sur [...] pour parcourir votre système jusqu'au fichier OAS/Swagger 2.0 afin d'initialiser l'endpoint de votre composant, les mappings d'API et la documentation de votre définition d'API.

Endpoint

URL de l'endpoint du service où le service Web est fourni. Vous pouvez spécifier un numéro de port explicite, par exemple "http://localhost:8088/services/customers" ou bien utiliser le port par défaut de Talend et ne spécifier que le chemin relatif, par exemple "/services/customers".

Si vous avez installé la version mensuelle R2020-05 du Studio, ou une version ultérieure fournie par Talend, vous pouvez définir l'endpoint à l'aide de variables de contexte. Pour plus d'informations concernant la mise à jour mensuelle du Studio, consultez votre administrateur ou administratrice.

Type

Sélectionnez le type à utiliser pour fournir un service REST. Peut être Manual ou resourceClass.

Manual : déterminez le mapping de l'API REST manuellement dans la table si le composant cREST est utilisé comme fournisseur de service ou configurez la Méthode HTTP ainsi que les autres paramètres si le composant est utilisé comme consommateur de service.

resourceClass : sélectionnez ce type pour fournir la classe des ressources que vous souhaitez exporter comme service REST.

REST API Mapping

Cette table s'affiche lorsque le type de service Manual est sélectionné et que le cREST est utilisé comme fournisseur de service.

Cliquez sur le bouton [+] sous la table pour ajouter autant de lignes que nécessaire pour spécifier la requête HTTP :

Output Flow : spécifiez le nom du flux de sortie.

HTTP Verb : sélectionnez dans la liste une méthode HTTP entre GET, POST, PUT, DELETE, OPTIONS et HEAD.

URI pattern : renseignez ce champ avec l'URI REST décrivant la ressource.

Consumes : sélectionnez le type de format du contenu consommé que le composant va utiliser, entre XML or JSON, XML, JSON, Form, Multipart et Any lorsque, pour l'option HTTP Verb, POST ou PUT est sélectionné.

Produces : sélectionnez le type de format du contenu produit que le composant va utiliser, entre XML or JSON, XML, JSON, HTML et Any lorsque, pour l'option HTTP Verb, GET, POST, PUT ou DELETE est sélectionné.

Bean class : configurez la classe du bean lorsque, pour l'option HTTP Verb, POST ou PUT est sélectionné et le format du contenu consommé est XML or JSON, XML ou JSON.

Resource Class

Ce champ s'affiche lorsque le type de service resourceClass est sélectionné. Saisissez le nom de la classe de la ressource que vous souhaitez exporter en tant que service REST.

Operation

Ce champ s'affiche lorsque le type de service resourceClass est sélectionné et que le cREST est utilisé comme consommateur du service. Saisissez le nom de l'opération.

Relative Path

Ce champ s'affiche lorsque le type de service Manual est sélectionné et que le cREST est utilisé comme consommateur du service. Saisissez le chemin d'accès relatif au serveur REST à invoquer.

HTTP Method

Content Type

Ce champ s'affiche lorsque le type de service Manual est sélectionné et que le cREST est utilisé comme consommateur du service.

Sélectionnez XML, JSON ou FORM selon le type de média du contenu à charger dans le serveur. Cette liste apparaît uniquement lorsque vous sélectionnez la méthode POST ou PUT dans la liste HTTP Method.

Accept Type

Ce champ s'affiche lorsque le type de service Manual est sélectionné et que le cREST est utilisé comme consommateur du service.

Sélectionnez le type de média que le côté client est préparé à accepter pour la réponse, du côté serveur. Les options disponibles sont : XML, JSON et ANY. Lorsque l'option ANY est sélectionnée, le message de réponse peut être de tout type et sera transformé en une chaîne de caractères (string). Cette liste n'apparaît pas lorsque vous sélectionnez la méthode DELETE.

Response Class

Ce champ s'affiche lorsque le type de service Manual est sélectionné et que le cREST est utilisé comme consommateur du service. Saisissez le nom de la classe de la réponse.

Skip incoming data unmarshalling

Use Service Locator

Cochez cette case pour activer le Service Locator. Spécifiez l'espace de noms du Service ainsi que le nom du Service dans les champs correspondants.

Enable the Service Activity Monitoring

Cochez cette case pour activer le Service Activity Monitor.

Notez que cette option fonctionne uniquement dans le Runtime. Lorsque la Route est exécutée dans le Studio, il est recommandé de décocher cette case. Dans le cas contraire, des avertissements s'afficheront dans la console d'exécution.

Use Authentication

Cochez cette case pour activer l'option d'authentification. Sélectionnez le type d'authentification entre les suivants :

• HTTP Basic : la méthode la plus simple pour implémenter les contrôles d'accès aux ressources Web à l'aide de champs standards dans l'en-tête HTTP.
• SAML Token (ESB runtime only) : format de données XML basé sur des standards ouverts pour échanger des données d'authentification et d'autorisation entre un fournisseur d'identité et un fournisseur de service.
• Open ID Connect : extension pour OAuth2 permettant aux clients de vérifier l'identité de l'utilisateur final, se basant sur l'authentification effectuée par un serveur d'autorisation, ainsi que d'obtenir des informations de base sur le profil de l'utilisateur final, d'une manière interopérable et semblable à REST. Pour plus d'informations, consultez Talend Identity and Access Management (en anglais) et Gestion des autorisations et Ressources ESB.

Lorsque le composant cREST est utilisé comme consommateur, saisissez un nom d'utilisateur ou d'utilisatrice et un mot de passe dans les champs correspondants. Pour saisir le mot de passe, cliquez sur le bouton [...] à côté du champ Password, puis, dans la boîte de dialogue qui s'ouvre, saisissez le mot de passe entre guillemets doubles et cliquez sur OK afin de sauvegarder les paramètres.

Use Authorization

Cette option est disponible uniquement si vous avez souscrit à l'une des solutions Talend ESB. Elle apparaît lorsque l'option SAML Token (ESB runtime only) est sélectionnée dans la liste Use Authentication.

Lorsque le composant cREST est utilisé comme fournisseur de service, cochez cette case pour activer les autorisations.

Lorsque le composant cREST est utilisé comme consommateur de service, cochez cette case pour invoquer un appel autorisé et spécifiez le rôle du client dans le champ Role.

Use Business Correlation

Cochez cette case pour créer un ID de corrélation dans ce composant.

Vous pouvez spécifier un ID de corrélation ID dans le champ Correlation Value.

Log Messages

Cochez cette case pour enregistrer l'échange de messages dans la Route.

Expose Swagger specification

Cette option s'affiche lorsque le cREST est utilisé comme fournisseur de service et n'est disponible que lorsque le type de service Manual est sélectionné. Cochez cette case pour exposer la spécification Swagger et inclure l'interface d'utilisation Swagger dans le service REST, qui fournit une documentation API en ligne dans un format lisible par l'humain et quelques fonctionnalités de test simples.

Si la Route est exécutée dans le Studio, la spécification Swagger sera disponible à http://127.0.0.1:8090/ENDPOINT/swagger.json et http://127.0.0.1:8090/ENDPOINT/swagger.yaml. L'interface d'utilisation Swagger n'est pas disponible.

Si la Route est exécutée dans Talend Runtime, la spécification Swagger sera disponible à http://127.0.0.1:8040/services/ENDPOINT/swagger.json et http://127.0.0.1:8040/services/ENDPOINT/swagger.yaml. L'interface d'utilisation Swagger sera disponible à http://127.0.0.1:8040/services/ENDPOINT/api-docs?url=/services/ENDPOINT/swagger.json.

Si la Route est exécutée en tant que microservice ESB, la spécification Swagger sera disponible à http://127.0.0.1:8065/services/ENDPOINT/swagger.json et http://127.0.0.1:8065/services/ENDPOINT/swagger.yaml. L'interface d'utilisation Swagger sera disponible à http://127.0.0.1:8065/services/ENDPOINT/api-docs?url=/services/ENDPOINT/swagger.json.

Pour plus d'informations concernant la construction d'une Route pour un microservice ESB et l'exécution du microservice, consultez le Guide d'utilisation du Studio Talend.

Include Documentation into Swagger Spec

Cette option s'affiche lorsque le composant cREST est utilisé comme fournisseur de service et que la case Expose Swagger specification est cochée. Cochez cette option pour ajouter du contenu dans le champ Comment de l'onglet Documentation du composant dans la spécification et l'interface d'utilisation Swagger.

Pour plus d'informations concernant à l'onglet Documentation, consultez le Guide d'utilisation du Studio Talend.

Règle d'utilisation

Le composant cREST peut être un composant de début dans une Route, comme fournisseur de service, un composant de milieu ou un composant de fin comme consommateur de service.

Limitation

Du fait d'une incompatibilité de licence, un ou plusieurs Jar requis pour utiliser ce composant ne sont pas fournis. Vous pouvez installer les Jar manquants pour ce composant en cliquant sur le bouton Install dans l'onglet Component. Vous pouvez également trouver les Jar manquants et les ajouter dans l'onglet Modules de la perspective Integration de votre Studio. Pour plus d'informations, consultez la page Installation de modules externes. Pour plus d'informations concernant l'installation de modules externes, consultez Talend Help Center (https://help.talend.com).