Publier un API Portal
La fonctionnalité API Portal dans Talend Cloud API Designer vous permet de créer un portail d'API pour centraliser la documentation de vos API, afin de la partager facilement avec vos client·es.
Dans l'onglet API Portal, vous pouvez créer un dépôt GitHub privé contenant un modèle pour votre portail. Vos pouvez effectuer un push de votre documentation d'API dans ce dépôt en un clic.
Le portail, basé sur Hugo, générateur de sites statiques, se personnalise facilement en ajoutant votre logo et vos couleurs pour coller à votre style, ainsi qu'en ajoutant des pages pour du contenu personnalisé. Pour plus d'informations concernant Hugo, consultez la documentation Hugo. La version la plus récente supportée d'Hugo est la v0.145.0.
Une fois votre portail configuré, vous pouvez le déployer dans la cible de votre choix. Des exemples de déploiement d'un portail dans différentes cibles sont disponibles dans Déployer votre portail.
Prérequis pour API Portal
- Un rôle ayant l'autorisation API Portal - Create and edit (Création et modification). Cette autorisation est disponible dans le rôle prédéfini API Portal Publisher et peut également être ajoutée à tout autre rôle. Les rôles et autorisations des utilisateur·trices peuvent être modifiés par une personne ayant le rôle Security Administrator dans Talend Management Console. Pour plus d'informations, consultez Gestion des rôles.
- Un compte GitHub avec les droits de création et d'écriture dans un dépôt privé. Si vous souhaitez publier vers GitHub Pages, vous devez avoir un plan GitHub vous permettant de publier à partir d'un dépôt privé.