Créer une nouvelle métadonnée d'API REST depuis API Designer - 7.1

Guide utilisateur de Talend Data Services Platform Studio

author
Talend Documentation Team
EnrichVersion
7.1
EnrichProdName
Talend Data Services Platform
task
Création et développement
EnrichPlatform
Studio Talend

Avant de commencer

  • Assurez-vous que votre souscription à Talend Cloud vous permet d'utiliser Talend Cloud API Designer et Talend Cloud API Tester et que l'utilisateur via lequel vous vous connectez depuis le Studio a l'autorisation (Rôle) d'utiliser ces modules au sein de votre compte.
  • Vous avez configuré la connexion à Talend Cloud depuis la fenêtre Preferences dans la vue Talend > Talend Cloud. Pour plus d'informations concernant le paramétrage des préférences du Studio, consultez Configuration des préférences du Studio Talend.

Procédure

  1. 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.
    L'assistant Import API definition s'ouvre.
  2. Sélectionnez Import from API designer. Vos définitions d'API dans Talend Cloud API Designer (pour lesquelles l'utilisateur est celui que vous utilisez dans les préférences de Talend Cloud) et toutes les définitions d'API partagées avec cet utilisateur dans Talend Cloud API Designer s'affichent.
    Si la boîte de dialogue reste vide, cela signifie certainement que vous n'avez pas de définition d'API ou que vous n'avez accès à aucune définition d'API. Consultez Talend Cloud API Designer dans cette situation.
  3. Dans la liste, sélectionnez l'API à importer et cliquez sur Next.
  4. Cliquez sur Next pour afficher les propriétés de définition de l'API automatiquement renseignées avec le contenu de l'API.

    Champ

    Description

    Name

    nom de la définition de l'API. Ce champ est modifiable.

    Un message s'affiche si vous saisissez des caractères interdits.

    Purpose

    objectif ou information utile concernant la définition de l'API. Ce champ est modifiable.

    Description

    description contenant les informations vous permettant de décrire ce que fait la définition de l'API et comment elle le fait. Ce champ est modifiable.

    Author

    Champ en lecture seule affichant par défaut le nom de l'utilisateur courant.

    Locker

    Ce champ est en lecture seule car il reprend par défaut l'identifiant de l'utilisateur ayant verrouillé le Job courant. Ce champ est vide lorsque vous créez une définition d'API et contient des données uniquement lorsque vous modifiez les propriétés d'une API existante.

    Version

    Champ en lecture seule. Vous pouvez cependant incrémenter manuellement la version à l'aide des boutons M et m.

    Status

    Sélectionnez dans la liste le statut du Job que vous créez.

    Path

    Liste dans laquelle sélectionner le dossier dans lequel la définition d'API sera créée.

  5. Cliquez sur Finish pour valider la création et fermer l'assistant.
    La définition d'API créée s'affiche sous le nœud Metadata > REST API Definitions, dans la vue Repository.
    Dans le menu contextuel, vous pouvez :
    • Open in API Designer : ouvrir une page Web externe affichant la définition d'API dans API Designer.
    • Open API documentation : ouvrir une page Web externe affichant la documentation de l'API.
    • Open in API Tester : ouvrir API Tester localement dans un navigateur Web externe.
    • Edit API definition : modifier les propriétés de la définition de l'API.
    • Update API definition : utiliser la mise à jour pour utiliser une nouvelle version ou une version mise à jour dans la définition de l'API.