Accéder au contenu principal

Prévisualiser et tester votre définition d'API

Utilisez les fonctionnalités de documentation en temps réel et de mock d'API pour obtenir une prévisualisation de votre API et la tester avec un échantillon de données.

La documentation en temps réel vous permet de générer une prévisualisation de la documentation de votre API, basée sur les descriptions et exemples fournis dans votre défnition d'API. Une fois la documentation en temps réel activée, elle est automatiquement mise à jour lorsqu'une modification est effectuée dans la définition de l'API. Elle peut être partagée avec votre équipe ou des utilisateur·trices externes et vous pouvez définir un mot de passe afin d'en sécuriser l'accès.

La fonctionnalité de mock d'API vous permet de générer un prototype de votre API afin de tester sa conception. Elle utilise l'échantillon de données en se basant sur les valeurs spécifiées dans les champs Examples, Enum et Default pour chaque type de données.

Vous pouvez utiliser le bouton API Tester pour générer un projet de test dans Talend Cloud API Tester avec des requêtes prêts à l'envoi.

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 – dites-nous comment nous améliorer !