REPOSITORY OVERVIEW

Live repository statistics

★ 5Stars

⑂ 0Forks

◯ 0Open issues

◉ 5Watchers

README preview

API de Tareas (TODOs) - Prueba Técnica

Esta es una solución para la prueba técnica de Programador Backend.
Se ha desarrollado una API REST utilizando FastAPI y PostgreSQL para administrar una lista de tareas (TODOs), siguiendo todos los requerimientos y considerando las problemáticas adicionales propuestas.

✨ Características Principales

Stack Tecnológico: FastAPI, PostgreSQL, SQLAlchemy, Pydantic, Alembic.
Asíncrono: Toda la API, incluyendo las interacciones con la base de datos, es completamente asíncrona para un alto rendimiento.
Autenticación: Sistema robusto basado en tokens JWT (JSON Web Tokens).
Seguridad: Cada usuario solo puede acceder y gestionar sus propias tareas.
Manejo de Datos: Paginación para manejar grandes volúmenes de tareas de manera eficiente.
Contenerización: Proyecto dockerizado con Docker Compose para un despliegue y desarrollo sencillos.
Migraciones: Alembic para gestionar las migraciones del esquema de la base de datos.
Testing: Conjunto de tests automatizados con pytest para garantizar la fiabilidad del código.
Logging: Sistema de logging configurado para monitorizar errores y eventos importantes.

🚀 Cómo Correr el Proyecto

📋 Pre-requisitos

Tener instalado Docker y Docker Compose.

🔧 Instrucciones de Levantamiento

Clona el repositorio:

git clone https://github.com/alejandrofonsecacuza/TODO-Technical-test.git
cd TODO-Technical-test

Crea un archivo de entorno:

cp .env.example .env

Levanta los servicios con Docker Compose:

docker-compose up -d --build

La API estará disponible en http://localhost:8000.

📖 Documentación Interactiva

Una vez que la API está corriendo, puedes acceder a la documentación generada por FastAPI:

Swagger UI → http://localhost:8000/docs
ReDoc → http://localhost:8000/redoc

⚙️ Ejemplos de Uso de los Endpoints

1. Registrar un nuevo usuario

curl -X POST "http://localhost:8000/users/register" \
-H "Content-Type: application/json" \
-d '{
  "email": "user@example.com",
  "password": "a_strong_password"
}'

2. Obtener un Token de Acceso (Login)

curl -X POST "http://localhost:8000/users/login" \
-H "Content-Type: application/x-www-form-urlencoded" \
-d "username=user@example.com&password=a_strong_password"

Respuesta:

{
  "access_token": "eyJhbGciOiJIUzI1NiIsInR...",
  "token_type": "bearer"
}

💡 Guarda el access_token para usarlo en las siguientes peticiones.

3. Crear una Nueva Tarea

curl -X POST "http://localhost:8000/tasks/" \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{
  "title": "Mi primera tarea",
  "description": "Descripción de la tarea."
}'

4. Listar Todas las Tareas del Usuario

curl -X GET "http://localhost:8000/tasks/" \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN"

5. Obtener una Tarea Específica

curl -X GET "http://localhost:8000/tasks/{task_id}" \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN"

6. Actualizar una Tarea

curl -X PUT "http://localhost:8000/tasks/{task_id}" \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{
  "title": "Título actualizado",
  "description": "Descripción actualizada",
  "status": "completed"
}'

7. Eliminar una Tarea

curl -X DELETE "http://localhost:8000/tasks/{task_id}" \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN"

🧪 Cómo Correr los Tests

Ejecuta los tests automatizados con:

docker-compose exec web pytest

🏛️ Decisiones de Diseño y Arquitectura

✅ Resolución de Problemáticas Adicionales

Alta Concurrencia

Uso de FastAPI (asíncrono) para manejar múltiples peticiones concurrentes sin bloqueo.
Conexión a PostgreSQL con asyncpg, el driver asíncrono más rápido para Python.

Grandes Volúmenes de Datos

Paginación en GET /tasks/ con parámetros skip y limit.
Índices en user_id de la tabla de tareas para mejorar rendimiento en consultas.

Escenarios de Error

Validación con Pydantic → errores 422 con mensajes claros.
Manejo explícito de errores → 404 cuando una tarea no existe para el usuario.

Seguridad

Autenticación con JWT.
Aislamiento de datos → un usuario solo accede a sus propias tareas.

📂 Estructura del Proyecto

.
├── alembic/               # Archivos de migración de Alembic
├── app/                   # Directorio principal de la aplicación
│   ├── core/              # Configuración de la aplicación (settings, utils)
│   ├── db/                # Conexión y modelos de base de datos
│   │   ├── models/        # Definición de modelos ORM (SQLAlchemy)
│   │   ├── session.py     # Configuración de la sesión/engine
│   │   └── base.py        # Base declarativa de SQLAlchemy
│   ├── dependens/         # Dependencias de seguridad y DB (FastAPI Depends)
│   ├── api/               # Routers de la API (endpoints)
│   │   └── v1/            # Versión 1 de la API con submódulos de rutas
│   ├── schemas/           # Esquemas Pydantic para validación
│   └── main.py            # Punto de entrada de la aplicación
├── tests/                 # Tests automatizados (pytest)
├── .env                   # Variables de entorno
├── .env.example           # Ejemplo de variables de entorno
├── docker-compose.yml     # Orquestación de servicios Docker
├── openapi.json           # Especificación OpenAPI exportada
├── requirements.txt       # Dependencias del proyecto
├── Dockerfile             # Definición del contenedor de la API
└── README.md              # Documentación principal

ALGORITHMICALLY RELATED

Similar Open-Source Projects

Selected from shared topics, language and repository description—not editorial ratings.

Trycatch-tv /

30-dias-de-proyectos-en-python

★ 122

La idea de este proyecto es facilitar una vía para que pudan practicar con ejercicios sencillos; no hace falta tener conocimientos avanzados para participar, esta metodología busca incentivar el crecimieento de conocimiento mediante la búsqueda de lo requerido para completar cada reto.

Recently updatedActive repository

PythonNo license#beginner-friendly#kiby#python

⑂ 30 forks◯ 2 issuesUpdated 5 days ago

View details View on GitHub ↗

GaedoC /

AppisPublicas

★ 33

Listado de API's Públicas en Chile Listado de API's Públicas para distintos tipos de servicios digitales nacionales Enlace Servicios Públicos / Gobierno API Biblioteca del Congreso Leyes, Proyectos de Ley y Normas. API Mercado Público: Todo lo que necesitas es estar conectado con los servicios de información disponibles en api.mercadopublico.cl para crear notificaciones y estar siempre actualizado de los negocios con el Estado. API División Político Administrativa: Permite obtener Regiones, Provincias y Comunas. API Portal ChileAtiende: API del Portal de Servicios del Estado - ChileAtiende. Plataforma Ley de Lobby La API de la plataforma Ley de Lobby implementada para el Gobierno de Chile, es la interfaz para programadores que permite integrar los contenidos de este portal en tu sitio web. API Energía Abierta - Comisión Nacional de Energía: API permite el acceso directo a los datos publicados en el sitio de datos abiertos de Comision Nacional de Energía. API Comisión Nacional de Energía: Provee el público acceso a la información que se genera dentro de la CNE considerando sus distintos sistemas de información. Usado en Bencina en línea API Datos Peñalolen - Municipalidad de Peñalolen: API que permite el acceso directo a los datos publicados en el sitio de datos abiertos de Peñalolén. API Datos Providencia - Municipalidad de Providencia: API que permite el acceso directo a los datos publicados en el sitio de datos abiertos de la Municipalidad de Providencia. Compras Transparentes: Desarrollada en Falcon y Python, contiene todos los detalles de la API de Compras Transparentes que permite explorar las transacciones entre el Estado de Chile y las empresas, las cuales se efectúan a través de la plataforma de compras públicas. ChileCompra: La API permite el acceso directo a los datos publicados en el portal de datos abiertos de ChileCompra desde tu aplicación. Usa una interfaz RESTful y retorna los datos en formato JSON. Las vistas invocadas a través de la API proveen un acceso estándar online a datos contenidos en páginas HTML, XLS, CSV y otros archivos similares disponibles en Internet. Portal de Datos Públicos: La versión actual de la API es 1.0. La mayoría de los métodos retorna sus resultados en formato JSON, excepto el metodo invoke donde puede elegirse entre varios formatos de salida. Cada key obtenida para la API del Portal de Datos Públicos del Gobierno de Chile está limitada a 10.000 reqs/mes y 1 req/seg. Seguimiento de pedidos de Correos de Chile: Módulo npm para hacer el seguimiento de uno o más pedidos de Correos de Chile. Correos Chile Tracking API: AfterShip Restful JSON APIs and webhooks allow developers to add Correos Chile tracking function easily. Support APIs Client Libraries for PHP, Java, Node.js, Python, .NET, Ruby. Correos Chile API: EasyPost is a multi-carrier shipping solution. The EasyPost API is one integration point for 60+ carriers, including Correos Chile. Feriados en Chile 2017: API con info de feriados en Chile año 2017. Feriados Legales en Chile: API sin restricciones y costos, que contiene todos los feriados legales de Chile. Turnos de Farmacia: URL para obtener en formato JSON el listado de farmacias del país y sus turnos nocturnos legales, directamente desde FARMANET del Ministerio de Salud. Transporte BIP: Get balance of bip card (Chile) by scrapping http://www.tarjetabip.cl/ Economía Indicadores económicos diarios: Este es un servicio open source (web service) que entrega los principales indicadores económicos para Chile en formato JSON. Tanto los indicadores diarios como históricos para que desarrolladores puedan utilizarlos en sus aplicaciones o sitios web. Indicadores del Día: Los indicadores que entregamos en el servicio, aparecen en el sitio del Banco Central de Chile (http://www.bcentral.cl/), estos datos son actualizados cada una hora y servidos en diferentes formatos como xml, json, csv y javascript. API SBIF: La API de SBIF permite obtener información de manera directa desde la base de datos del sitio web utilizando los servicios web provistos en esta plataforma. Buda.com: La API REST de Buda.com, exchange de criptomonedas por moneda local en Chile, Colombia, Perú y Argentina. Permite el manejo de ordenes de compra/venta, abonos/retiros e información del mercado en tiempo real. BCI: API públicas del Banco de Crédito e Inversiones. Permite obtener información sobre cuentas, indicadores económicos, información del banco, entre otros. Medios de Pago Khipu: API REST para crear cobros y recibir pagos con Khipu. Flow: Flow es una plataforma de pagos online que te permite pagar y recibir pagos de cualquier persona usando tarjetas de credito o débito. Sistemas de Alerta Sismos Chile: Últimos sismos en Chile. Chile Alerta - Api: Boletines de Tsunami en Chile, Últimos sismos en Chile y Últimos sismos en países específicos y el Mundo. Mapas / Geocodificación API Planos.cl: API Planos.cl de hibu está conformada por clases desarrolladas en lenguaje Javascript. API de Mapas y Geocodificación de Mapcity: La API de MapCity es una extensión de Openlayers y ExtCore. Los tipos básicos de la API y los controles son derivados de los tipos y controles de OpenLayers, por lo tanto la mayoría de las funciones de OpenLayers aplican a las funciones de la API. Entretención y ocio Horóscopo Yolanda Sultana: Obtiene el horóscopo del día desde Login.cl. No hay forma de obtener horóscopos anteriores, porque es de mala suerte. Clima API Tiempo Meteored.cl: La Api de Meteored.cl es una aplicación con la que usted puede obtener la predicción meteorológica de las localidades que desee a diario. Cómo Aportar: Seguir el siguiente formato: - [Nombre / Título sitio web](URL documentación API): Descripción corta de qué se trata este servicio, en general se encuentra

TODO-Technical-test