Ajouter une définition d’API

July 1, 2020

Contribution de: C

Une définition d’API est un document qui décrit une API qui suit les normes de spécification OpenAPI. Cette définition peut contenir des chemins d’accès aux ressources API et des méthodes pour les exploiter. Vous pouvez ajouter des définitions d’API à ADM, puis les déployer sur une Gateway d’API. Avec ce déploiement, API Gateway garantit un accès sécurisé et fiable aux ressources API dans la définition.

Pour ajouter une définition d’API dans l’interface graphique d’ADM, effectuez les opérations suivantes :

Accédez à Applications > Passerelle API > Définitions API.
Cliquez sur Add.
Cliquez sur Charger la spécification OAS.

Remarque

Assurez-vous que le fichier de spécification OAS est au format YAML ou JSON. Et, ce fichier ne doit pas contenir de références externes. Actuellement, ADM prend en charge Swagger version 2.0.
Parcourez une spécification OAS à partir de votre ordinateur local et téléchargez vers ADM.

La page Définitions de l’API répertorie la définition téléchargée. Cliquez sur Afficher pour afficher les détails de définition d’API suivants :

Nom : affiche le nom d’une définition d’API.
Définition de l’API : affiche le titre, la version, le chemin de base et l’hôte d’une définition.
Ressources API : répertorie les ressources API dans une définition d’API et leurs méthodes pour les exploiter.

Ensuite, déployez cette définition sur une passerelle API.

La version officielle de ce document est en anglais. Certains contenus de la documentation Citrix ont été traduits de façon automatique à des fins pratiques uniquement. Citrix n'exerce aucun contrôle sur le contenu traduit de façon automatique, qui peut contenir des erreurs, des imprécisions ou un langage inapproprié. Aucune garantie, explicite ou implicite, n'est fournie quant à l'exactitude, la fiabilité, la pertinence ou la justesse de toute traduction effectuée depuis l'anglais d'origine vers une autre langue, ou quant à la conformité de votre produit ou service Citrix à tout contenu traduit de façon automatique, et toute garantie fournie en vertu du contrat de licence de l'utilisateur final ou des conditions d'utilisation des services applicables, ou de tout autre accord avec Citrix, quant à la conformité du produit ou service à toute documentation ne s'applique pas dans la mesure où cette documentation a été traduite de façon automatique. Citrix ne pourra être tenu responsable de tout dommage ou problème dû à l'utilisation de contenu traduit de façon automatique.

Ajouter une définition d’API

July 1, 2020

Contribution de: C

Dans cet article

Éditer cette page