19. Validação de dados com o pacote Joi

Um aspecto crucial ao criar APIs em NodeJS é a validação de dados. A validação de dados é um processo que garante que os dados inseridos em uma aplicação sejam precisos, completos e atendam a todas as regras de negócios estabelecidas. Para facilitar esse processo, podemos utilizar o pacote Joi, uma poderosa biblioteca de validação de dados para JavaScript.

O Joi permite criar esquemas de validação de dados complexos com um mínimo de código e esforço. Ele fornece uma variedade de tipos de dados e regras de validação, tornando-o uma ferramenta extremamente flexível e poderosa para qualquer projeto NodeJS.

Ao trabalhar com APIs, a validação de dados é essencial para garantir a integridade dos dados e prevenir erros de entrada de dados. Por exemplo, ao criar uma API para um sistema de gerenciamento de usuários, você pode precisar garantir que o nome do usuário seja uma string, que o endereço de e-mail seja válido e que a senha atenda a certos critérios de complexidade. O Joi pode ajudar com tudo isso e muito mais.

Para começar a usar o Joi, primeiro precisamos instalá-lo em nosso projeto NodeJS. Isso pode ser feito usando o gerenciador de pacotes npm com o seguinte comando: npm install @hapi/joi.

Uma vez instalado, podemos importar o Joi para o nosso arquivo e começar a criar esquemas de validação. Um esquema é uma descrição das regras de validação que queremos aplicar aos nossos dados. Por exemplo, podemos criar um esquema para validar os dados de entrada do usuário da seguinte forma:

const Joi = require('@hapi/joi');

const schema = Joi.object({
  name: Joi.string().min(3).max(30).required(),
  email: Joi.string().email().required(),
  password: Joi.string().pattern(new RegExp('^[a-zA-Z0-9]{3,30}$')).required(),
});

Neste exemplo, o esquema define que o nome deve ser uma string com um mínimo de 3 caracteres e um máximo de 30, o endereço de e-mail deve ser uma string que passa na validação de e-mail e a senha deve ser uma string que corresponde a uma expressão regular específica.

Para validar os dados de entrada com este esquema, podemos usar o método validate() do Joi. Este método retorna um objeto que contém detalhes sobre qualquer erro de validação que possa ter ocorrido. Por exemplo:

const userInput = {
  name: 'John Doe',
  email: 'john.doe@example.com',
  password: 'password123',
};

const validationResult = schema.validate(userInput);

if (validationResult.error) {
  console.log(validationResult.error.details);
} else {
  console.log('User input is valid');
}

Se a entrada do usuário não passar na validação, o método validate() retornará um objeto que contém detalhes sobre o erro, incluindo a mensagem de erro e o caminho para o valor inválido. Podemos usar essas informações para informar ao usuário sobre o erro e como corrigi-lo.

O Joi também suporta a validação de tipos de dados mais complexos, como arrays e objetos. Por exemplo, podemos validar um array de strings da seguinte forma:

const arraySchema = Joi.array().items(Joi.string());

const arrayInput = ['apple', 'banana', 'cherry'];

const arrayValidationResult = arraySchema.validate(arrayInput);

if (arrayValidationResult.error) {
  console.log(arrayValidationResult.error.details);
} else {
  console.log('Array input is valid');
}

Da mesma forma, podemos validar um objeto que contém outros objetos ou arrays. Por exemplo, podemos validar um objeto que representa um usuário e seus endereços da seguinte forma:

const addressSchema = Joi.object({
  street: Joi.string().required(),
  city: Joi.string().required(),
  state: Joi.string().required(),
  zip: Joi.string().required(),
});

const userSchema = Joi.object({
  name: Joi.string().required(),
  email: Joi.string().email().required(),
  addresses: Joi.array().items(addressSchema),
});

const userInput = {
  name: 'John Doe',
  email: 'john.doe@example.com',
  addresses: [
    {
      street: '123 Main St',
      city: 'Anytown',
      state: 'CA',
      zip: '12345',
    },
    {
      street: '456 Elm St',
      city: 'Anytown',
      state: 'CA',
      zip: '12345',
    },
  ],
};

const validationResult = userSchema.validate(userInput);

if (validationResult.error) {
  console.log(validationResult.error.details);
} else {
  console.log('User input is valid');
}

Em resumo, o Joi é uma ferramenta poderosa e flexível para a validação de dados em projetos NodeJS. Ele pode lidar com uma variedade de tipos de dados e regras de validação, tornando-o uma excelente escolha para qualquer projeto que requer validação de dados robusta.