Mise à jour d'une spécification OpenAPI
Procédure
-
Ouvrez le fichier JSON Swagger que vous prévoyez de mettre à jour.
- Vous pouvez l'ouvrir à partir du document HCL Commerce ici : HCL Commerce API REST.
- Vous pouvez accéder au fichier JSON sur les serveurs HCL Commerce :
- Accédez à l'éditeur Swagger.
- Copiez et collez le contenu du fichier JSON Swagger dans le panneau de gauche de l'éditeur Swagger.
-
Modifiez la spécification :
Remarque : Vous pouvez utiliser l'option Insérer pour ajouter des éléments de chemin d'accès, une opération, des informations, une documentation externe, une déclaration de balise, ainsi que des balises à l'opération, aux serveurs et aux exemples de réponses.Remarque : Les erreurs de validation apparaîtront dans une notification en haut du volet de droite. - Lorsque vous avez fini d'éditer le fichier JSON, utilisez un validateur JSON pour garantir sa validité. L'éditeur Swagger ne valide pas la prise en charge de l'analyse lint JSON, il est donc nécessaire de passer par un Linter pour valider. Vous trouverez des validateurs JSON à l'adresse suivante : https://jsonlint.com/.
-
Lorsque l'édition du fichier JSON est terminée, copiez et collez le contenu dans le fichier de l'éditeur de texte.
Remarque : Evitez d'utiliser l'option dans l'éditeur Swagger. Cela créera un fichier JSON utilisant deux espaces plutôt que de quatre espaces pour l'onglet.