Mongoose Dynamic API

ES / EN

🇪🇸 ¿Qué es Mongoose Dynamic API?

¿Cuántas veces te has encontrado diseñando una aplicación, empezando a definir modelos de Mongoose y justo cuando crees que lo más difícil ha pasado… llega la parte tediosa?

Crear rutas, escribir controladores básicos, configurar colecciones en Postman para pruebas, insertar datos… y, cuando parece que todo está bajo control, te das cuenta de que necesitas agregar más modelos o modificar algunos.

Mongoose Dynamic API puede ayudarte con esto.

Solo define tus modelos de Mongoose, pásalos a mongoose-dynamic-api, pon a correr tu servidor y rápidamente obtendrás una API REST con un conjunto completo de operaciones CRUD:

GET ONE
GET MANY
POST
PUT BY ID
DELETE BY ID
DELETE BY LIST

Además, incluye una colección de usuarios ficticios para hacer pruebas rápidas.

También puedes pasarle tus middlewares personalizados para controlar la lógica de tus endpoints.
En definitiva, Mongoose Dynamic API genera un router completo por cada modelo, ahorrándote tiempo y esfuerzo. 🎯

🇺🇸 What is Mongoose Dynamic API?

How many times have you found yourself designing an app, defining your Mongoose models, and just when you think the hardest part is over… the tedious part kicks in?

Creating routes, writing basic controllers, setting up Postman collections for testing, inserting dummy data… and then you realize you need to add more models or tweak the existing ones.

Mongoose Dynamic API helps with that.

Just define your Mongoose models, pass them to mongoose-dynamic-api, start your server, and instantly get a REST API with full CRUD operations:

GET ONE
GET MANY
POST
PUT BY ID
DELETE BY ID
DELETE BY LIST

Plus, you get a fake users collection for quick testing.

You can also inject your own middlewares to customize endpoint logic.
In short, Mongoose Dynamic API generates a complete router for each model, saving you time and effort. 🎯

✅ Características Principales / Main Features

✅ Define tus modelos / Define your models
✅ Corre tu servidor / Start your server
✅ Obtén una API REST funcional con:
- CRUD básico / Basic CRUD
- Tus propios middlewares / Your custom middlewares
- Usuarios de prueba / Fake users
- JSON para Postman / Postman-ready JSON

🎯 Ideal para / Ideal For

Prototipos rápidos / Rapid Prototyping
Aplicaciones pequeñas y medianas / Small to Medium Applications
Fases de diseño y pruebas / Design & Testing Phases

🚀 Operaciones CRUD Automáticas / Automatic CRUD Operations

GET ONE: Obtener un registro por ID / Get one record by ID
GET MANY: Obtener múltiples registros con filtros / Get multiple records with filters
POST: Crear un nuevo registro / Create a new record
PUT: Actualizar un registro por ID / Update a record by ID
DELETE BY ID: Eliminar un registro por ID / Delete a record by ID
DELETE BY LIST: Eliminar múltiples registros por una lista de IDs / Delete multiple records by ID list

🛠️ Herramientas de Desarrollo / Development Tools

Listado automático de rutas / Auto-generated route list
Documentación JSON para Postman o Thunder Client / JSON docs for Postman or Thunder Client
Sistema de logging opcional / Optional logging system
Usuarios ficticios para pruebas rápidas / Fake users for testing (optional)

🎛️ Flexibilidad / Flexibility

Agrega tus propios middlewares / Add your own custom middlewares
Configuración sencilla / Simple configuration

👥 Sistema de Usuarios Fake / Fake Users System

Registro de usuarios ficticios / Mock user registration
Inicio de sesión rápido / Quick login for testing
Ideal para validar autenticación en prototipos / Ideal for testing authentication in prototypes
Fácil de activar o desactivar / Easy to enable or disable

🤔 ¿Por qué usarlo? / Why Use It?

✅ Desarrollo Rápido / Fast Development
✅ Consistencia / Consistent API structure
✅ Herramientas Integradas / Integrated Tools
✅ Adaptable / Fully Customizable

🛠️ Tecnologías Utilizadas / Tech Stack

Node.js
Express
Mongoose
MongoDB

📦 Instalación / Installation

npm install mongoose-dynamic-api