Accéder au contenu principal Passer au contenu complémentaire

Créer une nouvelle métadonnée d'API REST à partir d'un fichier

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.
    Boîte de dialogue Import API definition (Importer la définition de l'API).
  2. Sélectionnez Import from file (Importer depuis un fichier), choisissez un format d'API entre OAS/Swagger 2.0 et OAS 3.0 et parcourez votre système jusqu'au fichier d'API REST local.
    Une validation automatique de l'API est effectuée. Si le fichier est valide, les boutons Next et Finish sont disponibles. Si la validation échoue, il n'est pas possible d'aller plus loin. En revanche, si la validation n'affiche que des avertissements, vous pouvez les consulter via le lien fourni dans cette boîte de dialogue et décider de continuer ou non malgré les avertissements. Dans la plupart des situations, les avertissements ne sont pas pertinents et affichent les informations auxquelles vous devez prêter attention. La boîte de dialogue vous permet de procéder aux actions Next et Finish.
  3. Cliquez sur Next pour afficher les propriétés de définition de l'API automatiquement renseignées avec le contenu de l'API.
    Boîte de dialogue Import API definition (Importer la définition de l'API).
    Propriétés de la définition de l'API
    Champ Description
    Name (Nom) 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) 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 (Auteur) Champ en lecture seule affichant par défaut l'identifiant de l'utilisateur ou de l'utilisatrice actif.
    Locker Champ en lecture seule affichant par défaut l'identifiant de l'utilisateur ou de l'utilisatrice 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.
    Statut 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.
  4. 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 :
    • 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.

Cette page vous a-t-elle aidé ?

Si vous rencontrez des problèmes sur cette page ou dans son contenu – une faute de frappe, une étape manquante ou une erreur technique – faites-le-nous savoir.

Laissez vos commentaires ici