Définir les informations générales de l'API

Modifiez les informations générales concernant la version de votre API et définissez ses types de médias, ses URL de serveur et ses schémas de sécurité.

Procédure

Accédez à la page d'informations générales de votre API.
Cette page s'ouvre automatiquement après la création de votre API. Vous pouvez également l'ouvrir en cliquant sur le nom de votre API, en haut du panneau de gauche.
Dans la section General (Général), modifiez la version, la description, les coordonnées, les détails de licence et les conditions de service de votre API.

Note InformationsRemarque : Le nom de votre API peut être modifié depuis la page d'accueil de Talend Cloud API Designer. Pour plus d'informations, consultez Renommer une API.
Modifiez la section Media types (Types de médias) pour ajouter ou retirer des types de médias.
Les types de médias définis dans cette section sont globaux et appliqués à la version entière de l'API. Ils peuvent également être définis au niveau des opérations.
Ajoutez vos URL de serveur dans la section Server URLs (URL de serveur).
Les URL de serveur définies dans cette section sont globales et appliquées à la version entière de l'API. Une fois définies, vos URL de serveur s'affichent sous le nom de votre API en haut du panneau de gauche, avec l'endpoint de mock, s'il est activé.
Les URL de serveur publiées sont visibles dans la documentation en temps réel et dans le portail. La première URL de serveur publiée est également celle utilisée lors de l'essai de l'API dans Talend Cloud API Tester. Pour plus d'informations, consultez Essayer votre API dans Talend Cloud API Tester. Les URL de serveur qui ne sont pas publiées sont visibles uniquement dans Talend Cloud API Designer.

Note InformationsRemarque : Si vous avez plusieurs URL de serveur, la première de la liste est utilisée par défaut lorsque vous essayez votre API dans Talend Cloud API Tester.
Définissez la sécurité de l'API dans les sections Global security (Sécurité globale) et Security schemes (Schémas de sécurité).
La sécurité définie dans cette section est globale et est appliquée à la version entière de l'API. Elle peut également être définie au niveau des ressources et des opérations.

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