Gérer vos spécifications

Vous consultez la documentation d'Apigee Edge.
Consultez la documentation Apigee X. en savoir plus

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

Pour en savoir plus sur les spécifications OpenAPI, consultez 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.

Comme indiqué dans la figure précédente, la liste des caractéristiques vous permet d'effectuer les opérations suivantes:

• Créer et import des spécifications
• Générer un proxy d'API à partir d'une spécification à l'aide d'un assistant en plusieurs étapes
• Organisez vos spécifications à l'aide de dossiers et parcourez-les (voir la section Organiser le contenu à l'aide de dossiers).
• Modifier une spécification ou ouvrir un dossier en cliquant sur une ligne
• Renommer ou supprimer une spécification
• Rechercher dans la liste des spécifications et des dossiers

Créer une spécification OpenAPI

Pour créer une spécification OpenAPI:

1. Cliquez sur Develop > Specs (Développer > Spécifications) dans la barre de navigation latérale.
2. Cliquez sur + Spécification.
3. Cliquez sur New Spec (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 détails de spécification OpenAPI.
   Consultez Créer des spécifications à l'aide de l'éditeur de spécifications.
5. Cliquez sur Save (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 Develop > Specs (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 :
   • Import URL (Importer l'URL) pour importer la spécification à partir d'une URL. Indiquez le nom et l'URL lorsque vous y êtes invité.
   • Import file (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 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 Develop > Specs (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 des spécifications

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 disposez d'un proxy d'API dans Apigee Edge avec les chemins d'accès, les paramètres, les flux conditionnels et les 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.

Après avoir créé un proxy d'API à partir d'une spécification OpenAPI, si la spécification est modifiée, vous devrez modifier manuellement le proxy d'API pour refléter les modifications implémentées. Consultez la section Que se passe-t-il si je modifie une spécification ?.

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

1. Sélectionnez Develop > Specs (Développer > Spécifications) dans le menu de navigation latéral.
2. Si nécessaire, accédez au dossier contenant la spécification OpenAPI.
3. Placez votre 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 . L'assistant "Create Proxy" (Créer un proxy) s'ouvre et la page "Proxy details" (Détails du proxy) est préremplie à l'aide des valeurs de la spécification OpenAPI, comme illustré ci-dessous.
   
5. Cliquez sur Suivant.
6. Parcourez les pages restantes de l'assistant de création de proxy, comme décrit dans Créer un proxy d'API à partir d'une spécification OpenAPI. Commencez par 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 .
5. Modifiez le nom de la spécification.
6. Cliquez sur Renommer pour enregistrer les modifications ou sur Annuler pour annuler.

Déplacer une spécification dans un dossier

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

Supprimer une spécification

Vous pouvez supprimer une spécification du magasin de fichiers lorsqu'elle n'est plus nécessaire ou lorsqu'elle n'est plus 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 à supprimer pour afficher le menu d'actions.
3. Cliquez sur .
4. Cliquez sur Supprimer pour confirmer l'opération de suppression lorsque vous y êtes invité.
5. Supprimez les artefacts associés qui ne sont plus nécessaires.