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

Documentation de l'API

Talend Cloud API Designer vous permet de documenter votre API. La documentation est une étape importante dans le cycle de vie d'une API. Rédiger et maintenir la documentation peut être difficile, mais Talend Cloud API Designer vous permet de générer votre documentation automatiquement.

Qui écrit la documentation et qui la lit ?

Dans Talend Cloud API Designer, vous travaillez au sein d'une équipe de concepteurs d'API qui peuvent modifier votre définition d'API. Les membres de votre équipe peuvent contribuer à la documentation de votre API et générer un aperçu en temps réel.

La documentation en temps réel peut être partagée avec les membres de votre équipe, des partenaires, ou toute personne devant y accéder au cours de son développement.

Une fois votre documentation d'API prête à être rendue publique, vous pouvez la publier dans votre API Portal. Pour plus d'informations, consultez Publier un API Portal.

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 !