Este proyecto tiene como objetivo servir como una base para aprender y practicar el desarrollo de una API RESTfull con Node.js. Se construyó en diversas etapas, cada una reflejada en una rama distinta, para facilitar la comprensión y evolución del código.
MIT License
Este proyecto es una API desarrollada con Node.js y Express para gestionar estudiantes y cursos. La API permite realizar operaciones CRUD (Crear, Leer, Actualizar, Eliminar) sobre estudiantes y cursos, y está documentada con Swagger. El proyecto sigue una arquitectura MVC para separar la lógica de negocio, controladores y modelos, y está estilizado con NES.css en su interfaz básica.
Este proyecto tiene como objetivo servir como una base para aprender y practicar el desarrollo de una API RESTfull con Node.js. Se construyó en diversas etapas, cada una reflejada en una rama distinta, para facilitar la comprensión y evolución del código.
Vista de inicio de la aplicación.
graph TD;
Cliente-->|Solicitudes HTTP| Rutas;
subgraph MVC
Rutas-->|GET, POST, PUT, DELETE| Controladores;
Controladores-->|Lógica de negocio| Modelos;
Modelos-->|Datos simulados| BaseDeDatos;
end
Cliente-->|/estudiantes| Rutas;
Cliente-->|/cursos| Rutas;
Rutas-->|/estudiante/:id| Controladores;
Rutas-->|/curso/:id| Controladores;
Controladores-->|Respuestas JSON| Cliente;
BaseDeDatos["Estudiantes & Cursos (Datos simulados)"];
Controladores-->BaseDeDatos
El proyecto fue desarrollado en las siguientes etapas, cada una asociada a una rama en Git:
/api-docs
.El proyecto ha sido desplegado exitosamente en Vercel. Puedes acceder a la API y a su documentación de Swagger en los siguientes enlaces:
Para ejecutar este proyecto, necesitas las siguientes herramientas y dependencias:
Sigue estos pasos para instalar y configurar el proyecto en tu máquina local:
# Clonar el repositorio
git clone https://github.com/brayandiazc/node_api_estudiantes.git
# Entrar en el directorio del proyecto
cd node_api_estudiantes
# Instalar dependencias
npm install
Una vez instaladas las dependencias, puedes ejecutar el servidor con el siguiente comando:
# Ejecutar el proyecto en modo desarrollo con nodemon
npm run dev
El servidor se levantará en http://localhost:3000
, y podrás acceder a la documentación Swagger en http://localhost:3000/api-docs
.
Este proyecto utiliza arrays simulados como base de datos, por lo que no se requiere una base de datos real ni migraciones de modelos.
/api-docs
.Este proyecto no incluye autenticación ni credenciales de acceso, ya que su propósito es educativo.
Este proyecto está bajo la Licencia MIT - ve el archivo LICENSE.md para detalles.
⌨️ con ❤️ por Brayan Diaz C 😊