Vous consultez la documentation Apigee Edge.
Accédez à la documentation Apigee X.
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 :
- Créer une spécification OpenAPI
- Importer une spécification OpenAPI
- Modifier une spécification OpenAPI existante
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 votre spécification OpenAPI pour modéliser votre API au format JSON ou YAML dans le volet de gauche.
- Affichez la documentation de l'API générée automatiquement dans le volet de droite.
- Validez votre spécification par rapport à la norme OpenAPI Specification, au fur et à mesure de votre saisie.
- Enregistrez votre spécification OpenAPI ou fermez-la et annulez vos modifications.
Aide-moi avec JSON et YAML
JSON (JavaScript Object Notation) est un format d'échange de données léger utilisé pour 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 des données qui fournit une syntaxe pouvant être mappée sur des structures de données, telles que des listes, des tableaux associatifs et des scalaires. Pour en savoir plus, consultez https://yaml.org.
Les formats JSON et YAML sont lisibles par une machine, mais sont également faciles à lire et à comprendre pour les humains. La figure suivante compare deux courts extraits de la même spécification OpenAPI écrits en JSON et en YAML :
Valider une spécification
L'éditeur de spécifications valide votre spécification OpenAPI par rapport à la norme de spécification OpenAPI. À mesure que vous saisissez du texte, si des erreurs sont détectées dans votre spécification OpenAPI, l'éditeur de spécification affiche la boîte de dialogue "Erreur" en haut du volet de droite. Il fournit également plus d'informations sur les erreurs et les numéros de ligne associés pour que vous puissiez les corriger facilement.
Enregistrer une spécification
Pour enregistrer une spécification OpenAPI, cliquez sur Enregistrer dans la barre de navigation supérieure.
Si vous enregistrez la spécification pour la première fois, vous êtes invité à saisir un nom de fichier. Si vous ne spécifiez pas de nom de fichier, le nom par défaut est "Sans titre". Vous pourrez renommer la chaîne plus tard.
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.