UI de Swagger

Hay disponible una versión en vivo de la API de REST HCL Commerce en un navegador web del servidor de prueba HCL Commerce utilizando la interfaz de usuario de Swagger. Se compone de un conjunto de HTML estático, CSS y JavaScript que documenta dinámicamente la API REST disponible en el servidor de prueba de HCL Commerce.

Nota:

A partir de la versión 9.1.6, la interfaz de usuario de Swagger no se proporciona con las API de REST de HCL Commerce. Para ver las API de REST mediante la interfaz de usuario de Swagger, utilice el Editor de Swagger.

Para obtener más información, consulte API REST.

Importante:
  • Por razones de seguridad, Swagger no debe exponerse al entorno de producción en tiempo real.

    Puede restringir su exposición de las siguientes maneras:

    • Si los puertos de la API de REST no son necesarios para exponerse externamente, asegúrese de que están bloqueados por las reglas del firewall. Estos puertos incluyen 5443, 3738, 9443, 30901, 30921 y 30801.
    • Si necesita exponer estos puertos:
      1. Deshabilite la API de detección de REST para Transaction server. Para obtener más información, consulte Habilitar e inhabilitar la API de REST Discover.
      2. Asegúrese de configurar el servidor web para bloquear el acceso a los siguientes puntos finales swagger:
        • https://commerceHostname:3738/search/resources/swagger
        • https://commerceHostname:9443/commerceue/extension/swagger
        • https://commerceHostname:30901/search/resources/swagger
        • https://searchHost:30921/search/resources/swagger
        • https://searchHost:30801/swagger-ui.html#/
  • La UI de Swagger se proporciona tal cual. Contiene la API REST de HCL Commerce y otra información que está relacionada con el fondo de Swagger. No se soporta la personalización de la UI de Swagger, por ejemplo, para visualizar manejadores de recursos personalizados, anotaciones o datos adicionales.

La siguiente captura de pantalla muestra el página de inicio de la interfaz de usuario de Swagger:
Swagger captura de pantalla de UI
Donde:
  • Cada clase de manejador de recursos muestra una breve descripción del servicio.
  • Mostrar/ocultar expande o contrae el contenido de la API de cada clase.
  • Listar operaciones muestra una vista resumida del contenido de la API, donde se visualiza una fila para cada vía de acceso de método, con una breve descripción del servicio.
  • Expandir operaciones muestra una vista ampliada del contenido de la API, donde las filas se visualizan para la clase de respuesta, los parámetros y códigos de estado de cada método. La API se puede probar dinámicamente, seleccionando ¡Probar ahora! en la vista ampliada.
  • Sin formato muestra la información sin formato que la interfaz de usuario de Swagger utiliza para rellenar la página.