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édia, ses endpoints et ses schémas de sécurité.

Procédure

Accédez à la page des informations générales.
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.
Cliquez sur l'icône représentant un crayon, à gauche de la section GENERAL (INFORMATIONS GÉNÉRALES) afin de modifier la version, la description, les informations de contact et de licence, ainsi que les termes du service pour 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 pour ajouter ou supprimer 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 votre (vos) endpoint(s) dans la section ENDPOINTS.
Les endpoints définis dans cette section sont globaux et appliqués à la version entière de l'API. Une fois définis, vos endpoints s'affichent sous le nom de votre API en haut du panneau de gauche, avec l'endpoint de mock s'il est activé.
Les endpoints publiés sont visibles dans la documentation en temps réel et dans le portail. Le premier endpoint publié est également utilisé lors du test d'une API dans Talend Cloud API Tester. Pour plus d'informations, consultez Essayer votre API dans Talend Cloud API Tester. Les endpoints qui ne sont pas publiés sont visibles uniquement dans Talend Cloud API Designer.

Note InformationsRemarque : Si vous avez plusieurs endpoints, le premier de la liste est utilisé par défaut lorsque vous essayez votre API dans Talend Cloud API Tester. Vous pouvez déplacer un endpoint dans la liste en cliquant sur la barre à gauche de l'URL et en glissant vers le haut ou vers le bas.
Définissez la sécurité de l'API dans les sections GLOBAL SECURITY et SECURITY SCHEMES.
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.
Cliquez sur Save.

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