Cómo crear una API sencilla con validación en AdonisJS: Guía para principiantes

¡Hola! En este post, vamos a aprender cómo crear una ruta con una validación simple en AdonisJS. Este tutorial es amigable para principiantes, así que no te preocupes si eres nuevo en AdonisJS o en el desarrollo web en general.

Instalación

Lo primero es asegurarnos de tener AdonisJS instalado. Abre tu terminal y ejecuta el siguiente comando:

npm install -g @adonisjs/cli

Esto instalará la CLI de AdonisJS globalmente en tu máquina, para que puedas usarla para crear nuevos proyectos de AdonisJS y ejecutar comandos.

A continuación, creemos un nuevo proyecto de AdonisJS. Abre tu terminal y ejecuta el siguiente comando:

adonis new simple-api && cd simple-api

Esto creará un nuevo proyecto de AdonisJS en un directorio llamado simple-api.

Crea ruta

Ahora, creemos una ruta con una validación simple. Abre el archivo start/routes.js en tu editor de texto y agrega el siguiente código:

const Route = use('Route')
const { validate } = use('Validator')

Route.post('/users', async ({ request, response }) => {
  const validationRules = {
    username: 'required|unique:users,username',
    email: 'required|email|unique:users,email',
    password: 'required|min:8'
  }

  const validation = await validate(request.all(), validationRules)

  if (validation.fails()) {
    return response.badRequest(validation.messages())
  }

  const user = await User.create(request.all())
  return response.created(user)
})

Desglosemos lo que hace este código. Primero, importamos los módulos Route y Validator. Luego, definimos una ruta POST en /users. Esta ruta espera tres parámetros: username, email y password.

Definimos reglas de validación para estos parámetros usando la función validate del módulo Validator. Las reglas son:

username: Requerido y debe ser único en la tabla de usuarios.

email: Requerido, debe ser una dirección de correo electrónico válida y debe ser único en la tabla de usuarios.

password: Requerido y debe tener una longitud mínima de 8 caracteres.

Luego, usamos la función validate para validar la solicitud entrante con respecto a estas reglas. Si la validación falla, devolvemos una respuesta 400 Bad Request con los mensajes de error de validación. Si la validación pasa, creamos un nuevo usuario y devolvemos una respuesta 201 Created con el usuario recién creado.

Ejecuta la aplicación

Una vez que hayas creado tu aplicación, el siguiente paso es iniciar el servidor de desarrollo. Puedes hacerlo ejecutando el siguiente comando:

node ace serve --watch

Si quieres probar tu aplicación, te sugiero que uses Postman. Es una herramienta para probar APIs que te permite crear solicitudes y ver respuestas en una interfaz fácil de usar.

¡Y eso es todo! Has creado una ruta con una validación simple en AdonisJS. Ahora puedes probar tu ruta enviando una solicitud POST a /users con los parámetros requeridos. Si los parámetros pasan la validación, se creará un nuevo usuario y se devolverá en la respuesta.

Espero que este tutorial te haya sido útil. Si tienes alguna pregunta o comentario, no dudes en dejar un comentario a continuación. 🤗