Gérer vos spécifications

Vous consultez la documentation d'Apigee Edge.
Accédez à la documentation sur Apigee X. info

Apigee Edge vous permet de stocker vos spécifications OpenAPI. Gérez vos spécifications OpenAPI, comme décrit dans les sections suivantes.

Pour en savoir plus sur les spécifications OpenAPI, consultez la section Qu'est-ce qu'une spécification OpenAPI ?

Consulter la liste des caractéristiques

Pour accéder à la liste des spécifications:

  1. Connectez-vous à apigee.com/edge.
  2. Sélectionner une entreprise
  3. Sélectionnez Develop > Specs (Développer > Spécifications) dans le menu de navigation latéral.

La liste actuelle des spécifications et des dossiers s'affiche.

Liste des spécifications

Comme indiqué dans la figure précédente, la liste des spécifications vous permet de:

Créer une spécification OpenAPI

Pour créer une spécification OpenAPI:

  1. Cliquez sur Développer > Spécifications dans la barre de navigation latérale.
  2. Cliquez sur + Spécification.
  3. Cliquez sur Nouvelle spécification dans le menu déroulant. L'éditeur de spécifications s'ouvre.
  4. Remplacez l'exemple de spécification par vos propres informations de spécification OpenAPI.
    Consultez Créer des spécifications à l'aide de l'éditeur de spécifications.
  5. Cliquez sur Enregistrer pour enregistrer la spécification.
  6. Lorsque vous y êtes invité, saisissez un nom pour la spécification.
  7. Cliquez sur Enregistrer.

Importer une spécification OpenAPI

Pour importer une spécification OpenAPI:

  1. Cliquez sur Développer > Spécifications dans la barre de navigation latérale.
  2. Cliquez sur + Spécification.
  3. Cliquez sur l'une des options suivantes dans le menu déroulant :
    • Importer une URL pour importer la spécification à partir d'une URL. Spécifiez le nom et l'URL lorsque vous y êtes invité.
    • Importer un fichier pour rechercher la spécification dans votre répertoire local.
      La spécification est ajoutée à la liste.
  4. Cliquez sur le nom de la spécification pour l'afficher et la modifier dans l'éditeur de spécifications.
    Consultez la section Créer des spécifications à l'aide de l'éditeur de spécifications.

Modifier une spécification OpenAPI existante

Pour ouvrir une spécification OpenAPI existante:

  1. Cliquez sur Développer > Spécifications dans la barre de navigation latérale.
  2. Cliquez sur la ligne associée à la spécification dans la liste des spécifications.
  3. Modifiez la spécification dans l'éditeur de spécifications.
    Consultez Créer des spécifications à l'aide de l'éditeur de spécifications.

Créer un proxy d'API à partir d'une spécification de la liste

Avec Apigee Edge, vous pouvez créer vos proxys d'API à partir des spécifications OpenAPI que vous concevez et enregistrez dans l'éditeur de spécifications. En quelques clics, vous obtenez un proxy d'API dans Apigee Edge avec les chemins, paramètres, flux conditionnels et points de terminaison cibles générés automatiquement. Vous pouvez ensuite ajouter des fonctionnalités telles que la sécurité OAuth, la limitation du débit et la mise en cache.

Une fois que vous avez créé un proxy d'API à partir d'une spécification OpenAPI, si la spécification est modifiée, vous devez modifier manuellement le proxy d'API pour refléter les modifications implémentées. Consultez Que se passe-t-il si je modifie une spécification ?

Pour créer un proxy d'API à partir d'une spécification OpenAPI de la liste des spécifications:

  1. Sélectionnez Develop > Specs (Développer > Spécifications) dans le menu de navigation latéral.
  2. Accédez au dossier contenant la spécification OpenAPI, si nécessaire.
  3. Placez le curseur sur la spécification OpenAPI pour laquelle vous souhaitez créer un proxy d'API afin d'afficher le menu d'actions.
  4. Cliquez sur générer un proxy. L'assistant Create Proxy (Créer un proxy) s'ouvre, et la page Proxy details (Détails du proxy) est renseignée à l'aide des valeurs de la spécification OpenAPI, comme illustré ci-dessous.
    créer un assistant de création de proxy ;
  5. Cliquez sur Suivant.
  6. Suivez les étapes restantes de l'assistant de création de proxy, comme décrit dans la section Créer un proxy d'API à partir d'une spécification OpenAPI. (Recommencez à l'étape 8.)

Renommer une spécification

Pour renommer une spécification:

  1. Sélectionnez Develop > Specs (Développer > Spécifications) dans le menu de navigation latéral.
  2. Accédez au dossier contenant la spécification, si nécessaire.
  3. Placez le curseur sur la spécification que vous souhaitez renommer pour afficher le menu d'actions.
  4. Cliquez sur Renommer la spécification.
  5. Modifiez le nom de la spécification.
  6. Cliquez sur Renommer pour enregistrer les modifications ou sur Annuler pour les annuler.

Déplacer une spécification vers un dossier

Vous pouvez organiser vos spécifications dans des dossiers pour faciliter la gestion et la sécurité. Pour déplacer une spécification vers un dossier, consultez Organiser les spécifications à l'aide de dossiers.

Supprimer une spécification

Vous pouvez supprimer une spécification du Filestore lorsqu'elle n'est plus nécessaire ou qu'elle devient non valide.

Pour supprimer une spécification:

  1. Sélectionnez Develop > Specs (Développer > Spécifications) dans le menu de navigation latéral.
  2. Placez le curseur sur la spécification que vous souhaitez supprimer pour afficher le menu d'actions.
  3. Cliquez sur Icône Supprimer.
  4. Cliquez sur Supprimer pour confirmer la suppression dans l'invite.
  5. Supprimez les artefacts associés qui ne sont plus nécessaires.