Prácticas recomendadas para una experiencia de búsqueda basada en la configuración

Convenios de denominación

Utiliza nombres claros y coherentes para que los componentes sean fáciles de encontrar y comprender.

• Utiliza el formato «kebab» para los nombres de los componentes, como por ejemplo order-new-search.
• Incluye un prefijo de dominio, como order-, customer-, o return-.
• Añade el -search sufijo para los paneles de búsqueda.

Inscripción en el módulo

Decide si registrar los componentes en un módulo en función de tu arquitectura.

Utiliza el registro de módulos en estas situaciones.

• Trabajas con módulos de funciones que contienen varios componentes.
• Utilizas módulos de carga diferida.
• Te encargas del mantenimiento de los módulos compartidos.

Omita el registro del módulo en estos casos.

• Utilizas componentes independientes.
• Tienes pensado registrar los componentes manualmente.

Selección de la estrategia de paginación

Elige una estrategia de paginación que se adapte al tamaño de tus datos y al comportamiento de la API.

Utiliza la paginación del lado del servidor en estas situaciones.

• Trabajas con grandes conjuntos de datos.
• Necesitas que los resultados sean uniformes en todas las páginas.

Utiliza la paginación del lado del cliente en estas situaciones.

• Trabajas con conjuntos de datos más pequeños, como cientos de registros.
• Necesitas tener todos los datos disponibles de una sola vez.
• Tu API no admite la paginación.

Configuración de la API

Proporcione una configuración completa y precisa de la API para garantizar una integración fiable.

Especifique siempre los siguientes parámetros.

• apiName para definir el nombre exacto del método.
• responseMapping.data para definir la ruta de la matriz de datos.
• responseMapping.totalCount para definir la ruta de recuento total.

Si lo deseas, también puedes especificar los siguientes parámetros.

• requestMapping para admitir parámetros de API no estándar.
• requestDefaults para incluir valores de solicitud habituales.