Visualización de la API REST mediante Swagger en versiones anteriores a la 9.1.6

Si está usando una versión anterior a 9.1.6, puede acceder a la interfaz de usuario de Swagger para ver y probar todas las API de RESTful que se anotan con las anotaciones compatibles.

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#/
    - http://localhost:6643/approvals/v3/api-docs
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.

Antes de empezar

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 acerca de cómo ver las API de REST desde la versión 9.1.6 en adelante, vea HCL Commerce API REST.

Procedimiento

Inicie el servidor.
- Inicie el servidor de prueba de HCL Commerce, el servidor de pruebas de personalización, el servidor de prueba de búsqueda y el servidor de prueba de la tienda a través de la vista Servidores de HCL Commerce Developer.
- Inicie el servidor de transacciones, el servidor de personalización, el servidor de búsqueda y los contenedores de Docker del servidor de la tienda.
Inicie la sesión en la tienda de inicio como administrador del sitio.

Nota: El inicio de la sesión en la tienda configura los símbolos de seguridad para que pueda realizar llamadas REST desde Swagger. Aunque todavía puede ver los recursos REST en Swagger, si no inicia la sesión en la tienda con los permisos adecuados le impedirá ejecutar llamadas REST desde Swagger.
Acceda a la especificación de Swagger usando un navegador web.
- Para la API de REST del escaparate de HCL Commerce: https://hostname:5443/wcs/resources/api
- Para la API de REST de la solución de búsqueda basada en Solr: https://hostname:3738/search/resources/swagger
- Para la solución de búsqueda basada en Elasticsearch
  - API REST de consulta: https://commerceHost:30901/search/resources/swagger
  - API REST de consulta de datos: https://searchHost:30921/search/resources/swagger
  - API REST de ingesta: https://searchHost:30801/swagger
- Para las API de REST de xC desde el servidor de personalización: https://hostname:9443/commerceue/swagger/index.html.
  Se visualizan automáticamente las API de REST xC. Si no ve ninguna API, en el campo Explorar, especifique la URL https://hostname:9443/commerceue/extension/swagger siguiente.
Notes:
- De forma predeterminada, la página web de la interfaz de Swagger carga la URL para las API de REST de HCL Commerce. Después de actualizar el campo Explorar, Haga clic en el botón Explorar para evitar activar una renovación de página.
- Al probar las llamadas REST utilizando Swagger, seleccione el storeId que corresponda a la tienda en la que ha iniciado la sesión en el paso 2.
- Al acceder a la página de la interfaz de usuario de Swagger, se debe utilizar el mismo protocolo (https) para la URL de API de REST en el campo Explorar o se ejecutarán errores de compartición de recursos entre orígenes (CORS).
Si desea examinar los archivos .json de la API de REST directamente, se listan a continuación.