Maintenance des nœuds finaux OpenAPI

Pour éditer une spécification OpenAPI, utilisez l'éditeur Swagger. L'éditeur est un outil en ligne intégré au navigateur, disposant d'outils de validation intégrés et d'autres outils permettant de travailler avec les spécifications Swagger.

Before you begin

Pour afficher les API REST avec l'interface Swagger, utilisez l'éditeur Swagger. Vous pouvez configurer une copie locale de l'éditeur et de l'interface utilisateur. Pour plus d'informations, voir Configuration d'une instance Swagger locale.

Procedure

Ouvrez le fichier JSON Swagger que vous prévoyez de mettre à jour.
Vous pouvez soit extraire le fichier, comme décrit dans HCL Commerce API REST, soit y accéder à partir de l'un des serveurs HCL Commerce :
- Transaction : WC/xml/config/oas3/transaction
- Transaction : WC/xml/config/oas3/admin
- XC : commerceue-app/src/main/resources/com/ibm/commerce/ue/rest
Accédez à l'éditeur Swagger.
Copiez et collez le contenu du fichier JSON Swagger dans le panneau de gauche de l'éditeur Swagger.
Apportez vos modifications à la spécification.

Note: 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. 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, donc analysez par l'intermédiaire d'un Linter pour valider l'analyse lint.
Copiez et collez le contenu validé dans votre éditeur de texte, où vous avez initialement ouvert le fichier.

Important: N'utilisez pas l'option Fichier > Enregistrer en tant que JSON dans l'éditeur Swagger. Cela créera un fichier JSON qui utilise deux espaces plutôt que quatre espaces pour les onglets. Le format d'onglet à quatre espaces est obligatoire.