Esta guía te ayudará a configurar y ejecutar una API Flask en tu entorno local y crear una base de datos PostgreSQL llamada "eventos" con credenciales personalizadas. Asegúrate de tener Python y PostgreSQL instalados antes de comenzar.
-
Instalar Python: Si no tienes Python instalado, descárgalo e instálalo desde python.org.
-
Instalar PostgreSQL: Descarga e instala PostgreSQL desde el sitio oficial.
-
Crear una Base de Datos: Abre la consola de PostgreSQL y ejecuta los siguientes comandos para crear una base de datos llamada "eventos":
CREATE DATABASE eventos;
-
Descargar las dependencias: Dentro de la raiz de la aplicacion ejecutar el comando pip install -r requirements.txt para descargar las librerias necesarias.
-
Cambiar las credenciales de la BD: Dentro del archivo conexion.py cambiar credenciales de acceso a la BD
-
Ejecutar comando de ejecución: Dentro de la raiz del proyecto ejecutar el comando flask run o python /app.py
-
Endpoints peticiones http: La url cuando se ejecuta la aplicacon en local es localhost:5000 y sus distintos endpoins son:
Obtener todos los eventos: URL: /events GET: Obtener una lista de todos los eventos en la base de datos.
Crear un nuevo evento: URL: /events POST: Agregar un nuevo evento proporcionando datos en formato JSON.
Obtener un evento por su ID: URL: /events/<event_id> GET: Obtener información detallada de un evento específico por su ID.
Actualizar un evento por su ID: URL: /events/<event_id> PUT: Editar un evento existente proporcionando datos actualizados en formato JSON.
Eliminar un evento por su ID: URL: /events/<event_id> DELETE: Eliminar un evento específico por su ID.
-
Endpoints Swagger: Desde el endpoint http://localhost:5000/api/docs/ se puede revisar la documentación de la api y ejecutas las distintaciones peticiones http.
- Ejecutar contenedor docker: Con el comando dentro de la raiz del proyecto docker build -t nombre_de_la_imagen . se crea un una imagen docker de la api, para ejecutarla con el comando docker run -p 5000:5000 nombre_de_la_imagen Esto mapeará el puerto 5000 del contenedor al puerto 5000 de tu sistema local para que puedas acceder a tu aplicación Flask en http://localhost:5000.