Reto Squadmarkers

API Rest creada con el lenguaje Python, el Framework Flask Restful la cual es la encargada de retornar chistes desde el consumo de dos diferentes EndPoints, realiza acciones de crear un chiste en una base de datos de MongoDB, actualiza chistes en la base de datos de MongoDB, elimina chistes desde la base de datos de MongoDB y realiza cálculos matemáticos en base a el valor ingresado.

Prerequisitos 📋

Que se necesita para lanzar la API?

• Cliente Git para clonar repositorio
• Python (current latest version: 3.11.0)
• Instalador de paquetes PIP (es recomendable habilitar la instalación de PIP al momento de instalar Python en el SO)
• Base de datos local MongoDB
• Instalar módulos necesarios para la API (módulos establecidos en documento requirements.txt)
• Cliente Postman para realizar pruebas de los EndPoints (Opcional)

Como instalar 🔧

Clonar proyecto en un directorio

• Clonar proyecto en un directorio
• Crear un entorno virtual para hacer la instalación de los módulos necesarios

python -m venv venv

• Activar entorno virtual

venv\Scripts\activate

• Una vez activado el entorno virtual, instalar los módulos necesarios con el siguiente comando:

pip install -r requirements.txt

• Es momento de lanzar la API con el siguiente comando

python -m flask run

• La url principal del proyecto por defecto es http://localhost:5000/v1/

Documentación de API 🖹

• La documentación de este proyecto se encuentra en el archivo doc.yaml

Unittest

Las APIs fueron probadas bajo pruebas unitarias abarcando los casos que se solicitaba en el Reto. A continuación, se ejemplifica como utilizarla.

Para ejecutar la prueba unitaria seguir los siguientes pasos:

• Entrar al directorio /unittest del proyecto
• Una vez dentro del directorio /unittest ejecutar el siguiente comando:

python api_test.py

• Comenzará el proceso de prueba unitaria para los EndPoints de la API

¿Qué repositorio utilizaría para este proyecto? ❓

Análisis del porque utilicé MongoDB

• Para este caso de uso, donde los datos entregados por las APIs de chistes a consumir son del tipo JSON, la mejor opción es utilizar un repositorio de MongoDB ya que al ser una base de datos NoSQL entrega un escalamiento horizontal y el soporte para data no estructurada.

• Las sentencias de creación de la base de datos RetoDB y la collection chistes_collection se encuentra en el siguiente archivo create_mongodb_bbdd

Author ✒️

• Álvaro Muñoz - Software Developer - AlvaroMrJack

---

⌨️ with 💪 by AlvaroMrJack 🦅