Créer des spécifications à l'aide de l'éditeur de spécifications

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

Créez et validez des spécifications OpenAPI sans écrire de code à l'aide de l'éditeur de spécifications.

Accéder à l'éditeur de spécifications

Ouvrez une spécification OpenAPI dans l'éditeur de spécifications, comme décrit dans les sections suivantes:

La figure suivante montre la spécification de l'API Petstore ouverte dans l'éditeur de spécifications :

Comme le montre la figure précédente, l'éditeur de spécifications vous permet d'effectuer les opérations suivantes:

  • Créez la spécification OpenAPI pour modéliser votre API au format JSON ou YAML dans le volet de gauche.
  • Consultez la documentation sur les API générées automatiquement dans le volet de droite.
  • Validez votre spécification par rapport à la norme de spécification OpenAPI lors de la saisie.
  • Enregistrez votre spécification OpenAPI ou fermez la spécification et annulez vos modifications.

Aidez-moi à utiliser JSON et YAML

JSON (JavaScript Object Notation) est un format d'échange de données léger qui permet de représenter des structures de données simples et des tableaux associatifs. Pour en savoir plus, consultez https://www.json.org.

YAML (YAML Ain't Markup Language) est une norme de sérialisation/représentation de données qui fournit une syntaxe qui fournit également une syntaxe pouvant être mappée à des structures de données, telles que des listes, des tableaux associatifs et des scalaires. Pour en savoir plus, consultez https://yaml.org.

JSON et YAML sont tous deux lisibles par un ordinateur, mais ils sont également faciles à lire et à comprendre pour les humains. La figure suivante compare deux courts extraits de la même spécification OpenAPI écrite en JSON et YAML:

JSON et YAML

Valider une spécification

L'éditeur de spécifications valide votre spécification OpenAPI par rapport à la norme de spécification OpenAPI. Au fur et à mesure de la saisie, si la spécification OpenAPI comporte des erreurs, l'éditeur de spécifications affiche la boîte de dialogue "Erreur" en haut du volet de droite et fournit des informations supplémentaires sur les erreurs et les numéros de ligne associés pour vous permettre de les corriger facilement.

Erreurs

Enregistrer une spécification

Pour enregistrer une spécification OpenAPI, cliquez sur Save (Enregistrer) dans la barre de navigation supérieure.

Si vous enregistrez la spécification pour la première fois, vous êtes invité à entrer un nom de fichier. Si vous ne spécifiez pas de nom de fichier, la valeur par défaut est "Untitled" (Sans titre). Vous pourrez le renommer ultérieurement.

Fermer une spécification

Pour fermer une spécification OpenAPI sans enregistrer vos modifications, cliquez sur Annuler dans la barre de navigation supérieure. Vous êtes redirigé vers la liste des spécifications.