Melhores práticas para experiências de pesquisa orientadas por configuração

Siga estas práticas recomendadas para criar experiências de pesquisa consistentes, fáceis de manter e escaláveis. Seguir essas diretrizes ajuda a reduzir erros, melhorar a legibilidade e alinhar sua configuração aos padrões comuns de implementação.

Convenções de nomeação

Use nomes claros e consistentes para facilitar a localização e a compreensão dos componentes.

  • Use o formato "kebab" para nomes de componentes, como order-new-search.
  • Inclua um prefixo de domínio, como order-, customer-, ou return-.
  • Adicione o -search sufixo aos painéis de pesquisa.

Registro do módulo

Decida se deseja registrar componentes em um módulo com base na sua arquitetura.

Use o registro de módulos nessas situações.

  • Você trabalha com módulos de funcionalidades que contêm vários componentes.
  • Você usa módulos com carregamento diferido.
  • Você mantém os módulos compartilhados.

Ignore o registro do módulo nessas situações.

  • Você utiliza componentes independentes.
  • Você pretende registrar os componentes manualmente.

Seleção da estratégia de paginação

Escolha uma estratégia de paginação adequada ao tamanho dos seus dados e ao comportamento da API.

Use a paginação do lado do servidor nessas situações.

  • Você trabalha com grandes conjuntos de dados.
  • Você precisa de resultados consistentes em todas as páginas.

Use a paginação do lado do cliente nessas situações.

  • Você trabalha com conjuntos de dados menores, como centenas de registros.
  • Você precisa de todos os dados disponíveis de uma só vez.
  • Sua API não oferece suporte à paginação.

Configuração de API

Forneça configurações completas e precisas da API para ajudar a garantir uma integração confiável.

Especifique sempre os seguintes parâmetros.

  • apiName para definir o nome exato do método.
  • responseMapping.data para definir o caminho da matriz de dados.
  • responseMapping.totalCount para definir o caminho da contagem total.

Opcionalmente, você também pode especificar os seguintes parâmetros.

  • requestMapping para oferecer suporte a parâmetros de API não padronizados.
  • requestDefaults para incluir valores comuns de solicitação.