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 à la console NetScaler, puis les déployer sur une passerelle d’API (NetScaler).

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

• Télécharger le fichier de spécification OAS Swagger
• Créez votre propre définition d’API

Remarque :

NetScaler Console prend actuellement 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 OAS

Vous pouvez télécharger la spécification OAS dans l’interface graphique de la console NetScaler.

1. Accédez à Sécurité > Sécurité des API > Définitions des 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. NetScaler Console prend actuellement en charge la version 2.0 de Swagger.

4. Parcourez une spécification OAS depuis votre ordinateur local et téléchargez-la sur NetScaler Console.

Créer une définition d’API

Vous pouvez créer votre propre définition d’API dans l’interface graphique de la console NetScaler.

1. Accédez à Sécurité > Sécurité des API > Définitions des 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. Cliquez sur Ajouter. La ressource est ajoutée au tableau Ressources ajoutées . Cliquez sur Supprimer pour supprimer une ressource 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.