TodoApp

Sobre este proyecto 📌

Este es un proyecto personal de backend construido con Phoenix/Elixir. La aplicación está alojada en un servidor local haciendo uso de las siguientes herramientas:

Infraestructura y Sistema

• Ubuntu Linux: Sistema operativo del servidor (distribución Linux)
• CasaOS: Sistema de nube personal de código abierto que facilita la gestión de aplicaciones mediante Docker
• Docker: Plataforma de containerización que permite aislar y ejecutar aplicaciones en contenedores independientes
• Portainer: Herramienta de gestión visual para contenedores Docker, facilita la administración sin necesidad de comandos

Red y Acceso

• Túnel: Servicio de tunneling para exponer el servidor local a internet de forma segura
• Dominio personalizado: Nombre de dominio configurado para acceder a la API de manera profesional

---

Cómo iniciar esta aplicación 🧐

• Ejecuta mix setup para instalar y configurar dependencias
• Implementa tu base de datos en un nuevo archivo .env y ejecuta source .env
• Inicia el endpoint de Phoenix con:

  mix phx.server

o dentro de IEx:

  iex -S mix phx.server

---

API REST Endpoints

1️⃣ REGISTRO DE USUARIO

Endpoint: POST /api/register
URL: http://localhost:4000/api/register

Headers

Content-Type: application/json

Request Body

{
  "user": {
    "name": "Test",
    "last_name": "Test",
    "email": "test@test.com",
    "password": "password123",
    "password_confirmation": "password123"
  }
}

Response — 201 Created ✅

{
  "data": {
    "id": 1,
    "name": "Test",
    "last_name": "Test",
    "email": "test@test.com",
    "token": "SFMyNTY.g3QAAAABbQAAAAVwY...",
    "inserted_at": "2025-11-09T12:30:45Z",
    "updated_at": "2025-11-09T12:30:45Z"
  }
}

Response — 422 Unprocessable Entity ❌

{
  "errors": {
    "name": ["can't be blank"],
    "email": ["has already been taken"]
  }
}

---

2️⃣ LOGIN DE USUARIO

Endpoint: POST /api/login
URL: http://localhost:4000/api/login

Headers

Content-Type: application/json

Request Body

{
  "email": "test@test.com",
  "password": "password123"
}

Response — 200 OK ✅

{
  "data": {
    "id": 1,
    "name": "Test",
    "last_name": "Test",
    "email": "test@test.com",
    "token": "SFMyNTY.g3QAAAABbQAAAAVwY..."
  }
}

Response — 401 Unauthorized ❌

{
  "error": "Contraseña inválida"
}

Response — 404 Not Found ❌

{
  "error": "Usuario no encontrado"
}

---

4️⃣ Recuperar y cambiar contraseña 🔑

Solicitar recuperación de contraseña

POST /api/password/forgot

Body:

{
  "email": "test@test.com"
}

Respuesta exitosa:

{
  "message": "Si el correo existe, se ha enviado un email con instrucciones"
}

Cambiar contraseña con token

POST /api/password/reset

Body:

{
  "token": "<TOKEN_DEL_EMAIL>",
  "password": "nueva_password"
}

Respuesta exitosa:

{
  "message": "Contraseña actualizada exitosamente"
}

---

Logout (Cerrar sesión)

POST /api/logout

Headers: Authorization: Bearer <JWT_TOKEN>

Respuesta exitosa:

{
  "message": "Sesión cerrada correctamente"
}

---

2️⃣do método de recuperar contraseña

---

Solicitar recuperación de contraseña

POST /api/password/forgot

Body:

{
  "email": "test@test.com"
}

Respuesta exitosa:

{
  "message": "Si el correo existe, se ha enviado un email con instrucciones"
}

Correo con link para cambiar contraseña

Revisar bandeja /dev/mailbox

Formulario con Token para cambiar la contraseña

URL del formulario /reset-password?token=8sFJiDHH0u-0eWirl9bt...

Formulario procesa el cambio de contraseña

Mensaje de validación

---

5️⃣ CRUD de Notas (requiere autenticación)

---

a) Listar notas

GET /api/notes Headers: Authorization: Bearer <JWT_TOKEN>

Respuesta:

[
  {
    "id": 1,
    "title": "Nota 1",
    "content": "Contenido de la nota",
    "inserted_at": "2025-11-23T00:00:00Z"
  }
]

b) Crear nota

POST /api/notes Headers: Authorization: Bearer <JWT_TOKEN> Body:

{
  "title": "Nota nueva",
  "content": "Texto de la nota"
}

Respuesta:

{
  "id": 2,
  "title": "Nota nueva",
  "content": "Texto de la nota",
  "inserted_at": "2025-11-23T00:00:00Z"
}

c) Ver nota

GET /api/notes/:id Headers: Authorization: Bearer <JWT_TOKEN>

d) Actualizar nota

PUT /api/notes/:id Headers: Authorization: Bearer <JWT_TOKEN> Body:

{
  "title": "Nuevo título",
  "content": "Nuevo contenido"
}

e) Eliminar nota

DELETE /api/notes/:id Headers: Authorization: Bearer <JWT_TOKEN>

---

Ejemplo de flujo completo (usando test@test.com)

1. Registrar usuario con /api/register.
2. Iniciar sesión con /api/login y guardar el token.
3. Usar el token en el header Authorization para acceder a /api/notes (CRUD).
4. Para recuperar contraseña, usar /api/password/forgot y seguir el link del email.
5. Para cerrar sesión, llamar a /api/logout con el token.

---

Notas

• Todos los endpoints devuelven JSON.
• El token se debe enviar en el header Authorization como Bearer <token> para endpoints protegidos.
• El sistema está listo para integración con frontend web/mobile.
• Emails de bienvenida y recuperación se envían usando Swoosh (en dev, revisa consola/logs).

---

Tabla de Validaciones

Campo	Validación	Error ejemplo
name	Requerido, 2–50 caracteres	"can't be blank", "should be 2-50 character(s)"
last_name	Requerido, 2–50 caracteres	"can't be blank", "should be 2-50 character(s)"
email	Requerido, formato válido, único	"can't be blank", "has invalid format", "has already been taken"
password	Requerido, 8–100 caracteres	"can't be blank", "should be 8-100 character(s)"
password_confirmation	Debe coincidir con password	"does not match confirmation"