FastAPI CRUD Notes es un proyecto diseñado para gestionar notas mediante una API construida con FastAPI, utilizando MongoDB como base de datos. El objetivo principal de este proyecto es ofrecer un conjunto de endpoints para crear, leer, actualizar y eliminar (CRUD) notas de manera eficiente y escalable.
Cada nota tiene atributos como título, contenido, etiquetas, fecha de creación, historial de versiones, y más. La API permite a los usuarios no solo gestionar estas notas, sino también llevar un registro de los cambios realizados a lo largo del tiempo mediante un historial de versiones.
Características Principales: Creación de Notas: Permite crear una nueva nota con atributos personalizados como título, contenido, etiquetas, etc. Lectura de Notas: Posibilita la obtención de todas las notas o de una nota específica a través de su ID. Actualización de Notas: Facilita la modificación de una nota existente y registra los cambios en un historial de versiones. Eliminación de Notas: Permite eliminar una nota específica de la base de datos.
Instalación y Ejecución
Clonar el repositorio:
git clone https://github.com/guidopastorino/fastapi-crud-notes.git
cd fastapi-crud-notesInstalar las Dependencias:
pip install -r requirements.txtEjecutar la Aplicación:
uvicorn app.main:app --reloadDocumentación Interactiva:
- Accede a la documentación interactiva en http://127.0.0.1:8000/docs para probar los endpoints de la API.
Endpoints de la API
- Descripción: Crea una nueva nota.
- Entrada: Un objeto JSON que contiene los detalles de la nota (título, contenido, etiquetas, etc.).
- Salida: El ID de la nota recién creada.
- Descripción: Recupera una lista de todas las notas.
- Entrada: Ninguna.
- Salida: Una lista de notas.
- Descripción: Actualiza una nota existente.
- Entrada: El ID de la nota y un objeto JSON con los campos a actualizar.
- Salida: El número de documentos modificados.
- Descripción: Elimina una nota específica.
- Entrada: El ID de la nota.
- Salida: Un mensaje de confirmación de eliminación.