Architecture du dépôt - Cloud

Guide d'utilisation de Talend Cloud API Designer

Version
Cloud
Language
Français
Product
Talend Cloud
Module
Talend API Designer
Content
Création et développement > Création d'APIs
Last publication date
2024-03-13

Le dépôt utilisé pour construire et publier le portail est structuré comme suit :

Élément Description
.github Ce dossier contient les fichiers de configuration pour les Actions GitHub, utilisés pour déployer vers GitHub Pages ou Azure Static Web Apps par exemple.
apis Ce dossier contient la documentation API à publier. Il doit contenir un dossier pour chaque API et chaque dossier doit contenir un dossier par version. La documentation pour une version d'API est située dans apis/<api-name>/<api-version>/index.md.

Avec l'interface de Talend Cloud API Designer, cette structure est automatiquement créée lorsque vous publiez une API.

assets Ce dossier contient les fichiers gérés par l'utilisateur·trice, par exemple des fichiers JavaScript et CSS.
content Ce dossier contient les autres pages que vous souhaitez inclure dans votre portail. Par défaut, il contient une page d'accueil et une page de prise en main "Getting started".
static Ce dossier contient des fichiers statiques gérés par l'utilisateur·trice, comme des images et des polices.
themes Ce dossier contient le thème du portail. Il est fourni par Talend. Il n'est pas recommandé de le modifier. Si vous souhaitez personnaliser le thème, consultez Personnaliser votre portail.
config.toml Ce fichier contient la configuration du portail. Il spécifie le thème à utiliser lors de la génération du site et vous permet d'organiser vos API en catégories. Pour plus d'informations, consultez Organiser la liste de vos API.