Citrix Application Delivery Management service

Créer ou télécharger une définition d’API

Une définition d’API est un document qui décrit une API à l’aide des normes de spécification OpenAPI (Swagger 2.0, OpenAPI 3.0.x). 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 passerelle API (Citrix ADC).

Vous pouvez créer des définitions d’API de l’une des manières suivantes :

Remarque

Actuellement, ADM prend en charge l’analyse des fichiers de spécifications OAS qui utilisent Swagger 2.0 ou openapi 3.0.1.

Télécharger la spécification OEA

Vous pouvez télécharger la spécification OEA dans l’interface graphique ADM.

  1. Accédez à Applications > API Gateway > Définitions d’API.

  2. Cliquez sur Ajouter.

  3. Sélectionnez 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 la version 2.0 de Swagger.

  4. Parcourez une spécification OEA à partir de votre ordinateur local et téléchargez vers ADM.

Créer une définition d’API

Vous pouvez créer votre propre définition d’API dans l’interface graphique ADM.

  1. Accédez à Applications > API Gateway > Définitions d’API.

  2. Cliquez sur Ajouter.

  3. Sélectionnez Créer votre définition et spécifiez les éléments suivants :

    • Nom  : nom de la définition de l’API.

    • Définition de l’API - Une définition doit inclure le titre, la version, le chemin de base et l’hôte. Vous pouvez spécifier un nom de domaine ou une adresse IP dans le champ Hôte.

    • API Resources - Ajoutez plusieurs ressources API à votre définition. Chaque ressource a un chemin d’accès et une méthode prise en charge.

    Créer une définition d'API

  4. Cliquez sur Créer.

Afficher les définitions de l’API

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.

Créer ou télécharger une définition d’API