Créer ou 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. Cette définition peut contenir des chemins de ressources d’API et des méthodes pour les exploiter. Vous pouvez ajouter des définitions d’API à NetScaler Console, 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 :

Remarque :

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

Charger la spécification OAS

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

  1. Accédez à Security > API Security > API Definitions.

  2. Cliquez sur Add.

  3. Sélectionnez Upload OAS Specification.

    Remarque :

    Assurez-vous que le fichier de spécification OAS est au format YAML ou JSON. De plus, ce fichier ne doit pas contenir de références externes.

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

Créer une définition d’API

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

  1. Accédez à Security > API Security > API Definitions.

  2. Cliquez sur Add.

  3. Sélectionnez Create Your Definition et spécifiez les éléments suivants :

    • Name - Nom de la définition d’API.

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

    • API Resources - Ajoutez plusieurs ressources d’API à votre définition. Chaque ressource a un chemin et une méthode prise en charge. Cliquez sur Add. La ressource est ajoutée au tableau Added Resources. Cliquez sur Delete pour supprimer une ressource d’API.

    Créer une définition d'API

  4. Cliquez sur Create.

Afficher les définitions d’API

La page API Definitions répertorie la définition chargée. Cliquez sur View pour afficher les détails de la définition d’API suivants :

  • Name – Affiche le nom d’une définition d’API.

  • API Definition – Affiche le titre, la version, le chemin de base et l’hôte d’une définition.

  • API resources – Répertorie les ressources d’API dans une définition d’API et leurs méthodes pour les exploiter.

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