Habilitar e inhabilitar la API de REST Discover

Es posible que desee impedir que Swagger muestre su API RESTful en un navegador web, especialmente en un entorno de producción que esté atendiendo al tráfico en vivo. Al inhabilitar la API de descubrimiento de REST, puede impedir que los servicios de REST se recuperen y muestren en Swagger. De forma alternativa, puede habilitar la API de REST Discovery para ver y probar los servicios de REST con Swagger.

Por qué y cuándo se efectúa esta tarea

La disponibilidad de la API de descubrimiento de REST está controlada por la propiedad ApiDiscoveryEnabled. Puede cambiar esta propiedad dentro del archivo wc-component.xml para el componente foundation. Para obtener más información sobre cómo actualizar los archivos wc-component.xml, consulte Cambiar propiedades de configuración de REST en el archivo de configuración de componente (wc-component.xml).

Notes:
  • HCL Commerce DeveloperEl elemento ApiDiscoveryEnabled se establece en true (habilitado) en entornos HCL Commerce Developer de forma predeterminada.
  • En los entornos de ejecución, el elemento ApiDiscoveryEnabled está establecido en false (inhabilitado) de forma predeterminada.

Cuando actualice la versión del archivo wc-component.xml, asegúrese de que incluya la propiedad ApiDiscoveryEnabled y establezca el valor en true o false. Por ejemplo, el fragmento de código siguiente establece el valor para la propiedad en false, lo que inhabilita la API de REST Discovery:

<!-- Determines if the REST API Discovery should be enabled. -->
    <_config:property name="ApiDiscoveryEnabled" value="false"/>

Cuando la API Discovery se establece en false, un usuario todavía puede acceder a Swagger en un navegador web, pero no se visualiza ninguna API de REST.

Qué hacer a continuación

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