Mantenimiento de puntos finales OpenAPI

Para editar una especificación OpenAPI, utilice Swagger Editor. El Editor es una herramienta en línea en el navegador con herramientas de validación integradas y otras ayudas para trabajar con las especificaciones de Swagger.

Before you begin

Para ver las API de REST mediante la interfaz de usuario de Swagger, utilice el Editor de Swagger. Puede configurar una copia local del editor y la interfaz de usuario; para obtener más información, consulte Configuración de una instancia de Swagger local.

Procedure

Abra el Swagger JSON que tiene previsto actualizar.
Puede recuperar el archivo, como se describe en HCL Commerce API REST, o puede acceder a él desde uno de los servidores HCL Commerce:
- Transacción: WC/xml/config/oas3/transaction
- Transacción: WC/xml/config/oas3/admin
- xC: commerceue-app/src/main/resources/com/ibm/commerce/ue/rest
Vaya al Swagger Editor.
Copie y pegue el contenido de Swagger JSON en el panel izquierdo de Swagger Editor.
Realice los cambios en la especificación.

Note: Puede usar la opción Insertar para agregar elementos de ruta, operación, información, documentación externa, declaración de etiqueta, etiquetas a operación, servidores y respuestas de ejemplo. Los errores de validación aparecerán en una notificación en la parte superior del panel de la derecha.
Cuando haya terminado de editar el archivo JSON, use un validador JSON para garantizar su validez. El Swagger Editor no valida el soporte de linting JSON, así que analícelo a través de un linter para validar el linting.
Copie y pegue el contenido validado nuevamente en su editor de texto, donde originalmente abrió el archivo.

Important: No utilice la opción Guardar > Guardar como JSON en el Swagger Editor. Al hacerlo, se creará un archivo JSON que usa dos espacios en lugar de cuatro espacios para las pestañas. Es necesario el formato de la pestaña de cuatro espacios.