Boas práticas
Algumas boas práticas e também orientações sobre o uso do conector Node
A APIPASS oferece um conector Node.js, seguir boas práticas de desenvolvimento é essencial para garantir que suas integrações sejam eficientes, seguras e de fácil manutenção. Abaixo, descrevemos algumas boas práticas comuns e fornecer um exemplo prático em Node.js:
Boas Práticas em um Conector Node.js:
Usar Módulos e Bibliotecas: O conector disponibiliza algumas bibliotecas conhecidas da plataforma NodeJs, conforme mencionado no tópico Pacotes NPM disponíveis.
Gerenciar Erros Adequadamente: Utilize tratamento de erros para garantir que seu código lide com exceções de maneira apropriada. Isso inclui o uso de blocos
try...catche o registro de erros de forma significativa.Padronização de Código: Siga um estilo de codificação consistente. O uso de ferramentas como ESLint pode ajudar a garantir que o código siga padrões estabelecidos.
Documentação Clara: Documente seu código de forma clara, incluindo comentários explicativos, documentação de funções e descrições de parâmetros.
Gestão de Dependências de Forma Segura: A gestão de dependências é feita pelo time de plataforma da APIPASS.
Testes Automatizados: Crie testes automatizados para verificar se o seu código funciona conforme o esperado. Use estruturas de teste como Mocha ou Jest.
Aqui está um exemplo de código Node.js que usa a biblioteca htmlencode para codificar uma string:
Neste exemplo, a biblioteca htmlencode é importada, e uma string contendo código HTML malicioso é codificada usando a função htmlEncode(). O resultado é uma versão segura da string que pode ser exibida em uma página web sem executar o código malicioso.
IMPORTANTE:
Por questões de segurança, não é possível executar chamadas externas a partir do conector NodeJs, também não é possível importar bibliotecas usando o Require.
O uso do conector NodeJs é recomendado para cenários de mapeamento e manipulação de dados, considere o uso de outros conectores para demais casos de uso.
Em caso de dúvida entre em contato com time de suporte da APIPASS para identificar o conector ideal para o seu caso de uso.
Last updated