Bienvenido a CarlosRenting. Esta API proporciona endpoints para la gestión de una flota de coches de renting.
https://hub.docker.com/repository/docker/carloscallejasez/carlosrentingapi/general
https://carlos-renting-api-1.onrender.com
Este proyecto utiliza GitHub Actions para la integración continua (CI) y la entrega continua (CD) mediante Docker. Cada vez que se realiza un push a la rama principal del repositorio, GitHub Actions automatiza el proceso de construcción de la imagen Docker para la aplicación, así como su despliegue si es necesario. El archivo de flujo de trabajo .github/workflows/docker.yml contiene la configuración necesaria para esta automatización. Las credenciales de Docker Hub se almacenan de forma segura como secretos en el repositorio de GitHub, lo que garantiza un despliegue seguro y sin problemas de la aplicación en entornos de producción.
Accede a la documentación de la API en /api-docs
La API utiliza Cloudinary y Multer para gestionar el almacenamiento y manipulación de imágenes de manera eficiente. Cloudinary proporciona una solución robusta para almacenar imágenes en la nube, permitiendo un acceso rápido y seguro a las mismas. Multer, por otro lado, ayuda a manejar la carga de archivos en nuestra API, permitiendo a los usuarios subir imágenes directamente desde sus dispositivos.
Uso para implementación de un chat de soporte en tiempo real.
Axios es una librería HTTP basada en promesas que permite realizar solicitudes HTTP tanto desde el navegador como desde Node.js. En este proyecto, se Axios para hacer una llamada a una API externa (https://newsapi.org/) para obtener las últimas noticias de negocios.
Esta API utiliza Stripe para procesar pagos de manera segura y eficiente. Stripe ofrece una solución completa para aceptar pagos en línea, permitiendo transacciones con tarjetas de crédito, a través de la ruta /payment, que acepta solicitudes POST con el precio y el token de pago proporcionados en el cuerpo de la solicitud.
Este proyecto utiliza una capa de caché para mejorar el rendimiento al acceder a los datos del sensor. La caché se implementa utilizando la biblioteca node-cache.
Se ha implementado un manejador de errores personalizado para garantizar una experiencia consistente y segura para nuestros usuarios. Este manejador de errores está diseñado para capturar y manejar errores de manera eficiente en toda la aplicación. Ofrece un manejo específico para diferentes tipos de errores, como errores de validación de datos, errores de autenticación y otros errores internos del servidor.
Este middleware verificará si el campo de texto (text) tiene al menos 20 caracteres antes de permitir que el comentario se guarde en la base de datos.
Este módulo de suscripción te permite capturar correos electrónicos de usuarios interesados y enviarles boletines informativos utilizando Nodemailer. Es útil para mantener a tus usuarios actualizados sobre las novedades, promociones o cualquier otro contenido relevante.
En este proyecto, se usa Morgan como middleware para registrar logs de las solicitudes HTTP en un archivo de registro. Esto garantiza que los logs generados por las solicitudes HTTP sean registrados en el archivo access.log en la carpeta logs del proyecto.
Este proyecto incluye pruebas unitarias escritas utilizando Mocha, un popular marco de pruebas para Node.js. Las pruebas unitarias son una parte fundamental del proceso de desarrollo, ya que nos permiten verificar el funcionamiento correcto de cada componente de nuestra aplicación de forma aislada. Utilizamos Mocha junto con Chai y Chai-HTTP para escribir y ejecutar nuestras pruebas, asegurándonos de que nuestra aplicación funcione como se espera en diferentes escenarios. Para ejecutar las pruebas, simplemente ejecute el comando npm test en la terminal y Mocha se encargará de ejecutar todas las pruebas definidas en el directorio de pruebas.
Este proyecto incluye una página de error 404 personalizada para mejorar la experiencia del usuario cuando intenta acceder a una ruta que no existe en el servidor.
Agrega varias medidas de seguridad automáticas. Helmet configura encabezados HTTP relacionados con la seguridad, como la Política de Seguridad de Contenido (CSP), que ayuda a mitigar riesgos de Cross-Site Scripting (XSS) y otros ataques comunes.
Para garantizar la estabilidad y disponibilidad de la API, se ha un establecido un límite de peticiones utilizando el middleware express-rate-limit en Node.js. Este límite está configurado para permitir un máximo de 100 peticiones por hora por cliente. Esta medida permite controlar el tráfico entrante y prevenir sobrecargas en el servidor.
Ngrok es una herramienta que permite crear túneles seguros hacia servidores locales, lo que facilita el acceso a estos servidores desde Internet. Para exponer el puerto 5000, ngrok http 5000
Este script en Python simula un sistema embebido que detecta la velocidad de un coche y envía los datos a la API con el cuerpo de la llamada especificado como {"sensor": "value"}.
python speed.py
- GET /cars: Obtiene todos los coches. Se puede filtrar por marca y/o año utilizando los parámetros de consulta
brandyyear.- Ejemplo de filtro por marca:
/cars?brand=Toyota - Ejemplo de filtro por año:
/cars?year=2020 - Ejemplo de filtro combinado:
/cars?brand=Toyota&year=2020
- Ejemplo de filtro por marca:
- GET /cars/:id: Obtiene un coche por su ID.
- POST /cars: Crea un nuevo coche.
- PUT /cars/:id: Actualiza un coche existente.
- DELETE /cars/:id: Elimina un coche.
- GET /cars/available: Obtiene solo los coches disponibles.
- GET /reservations: Obtiene todas las reservas.
- GET /reservations/:id: Obtiene una reserva por su ID.
- POST /reservations: Crea una nueva reserva.
- PUT /reservations/:id: Actualiza una reserva existente.
- DELETE /reservations/:id: Elimina una reserva.
- GET /users: Obtiene la lista de usuarios.
- GET /users/:id: Obtiene un usuario por su ID.
- POST /users: Crea un nuevo usuario.
- PUT /users/:id: Actualiza un usuario existente.
- DELETE /users/:id: Elimina un usuario.
- POST /users/login: Login usuario.
- GET /comments: Obtiene todos los comentarios, ordenados por fecha de creación descendente.
- GET /comments/:id: Obtiene un comentario por su ID.
- POST /comments: Crea un nuevo comentario.
- PUT /comments/:id: Actualiza un comentario existente.
- DELETE /comments/:id: Elimina un comentario.
- GET /staff: Obtiene todos los miembros del personal.
- GET /staff/:id: Obtiene un miembro específico del personal por ID.
- POST /staff: Sube el avatar e información de un nuevo miembro del personal
- PUT /staff/:id: Actualiza la información de un miembro específico del personal.
- DELETE /staff/:id: Descripción: Elimina un miembro específico del personal.
- GET /chat/messages: Devuelve todos los mensajes de chat almacenados en la base de datos.
- POST /chat/messages: Guarda un nuevo mensaje de chat en la base de datos.
- GET /news: Devuelve las noticias de la Api NewsApi.
- GET /metrics: Devuelve las métricas de la Api.
- POST /data: Guarda datos en el data lake.
- GET /data: Devuelve los datos calculados del data lake
- POST /subscribe: Guarda el email del usuario interesado en la newsletter y envía un email de bienvenida.
Las siguientes rutas requieren autenticación mediante un token JWT válido:
-
GET /users/:id
- Descripción: Obtiene un usuario por su ID.
-
PUT /users/:id
- Descripción: Actualiza un usuario existente por su ID.
-
DELETE /users/:id
- Descripción: Elimina un usuario por su ID.
Para obtener un token JWT válido y acceder a las rutas protegidas, primero debes iniciar sesión utilizando la siguiente ruta:
- POST /users/login
- Descripción: Inicia sesión con nombre de usuario y contraseña.
- Parámetros de entrada:
username(nombre de usuario) ypassword(contraseña). - Respuesta exitosa: Devuelve un token JWT válido que se debe incluir en las solicitudes a las rutas protegidas en el encabezado de autorización.
Recuerda incluir el token JWT en el encabezado de autorización de las solicitudes a las rutas protegidas de la siguiente manera:
Authorization: Bearer <token_jwt>
Donde <token_jwt> es el token JWT válido obtenido al iniciar sesión.
ACCESS_TOKEN_SECRET=
MONGODB=
PORT=
CLOUDINARY_CLOUD_NAME=
CLOUDINARY_API_KEY=
CLOUDINARY_API_SECRET=
API_NEWS=
STRIPE_SECRET_KEY=
EMAIL_USER=
EMAIL_PASSWORD=