/nestjs-product-gallery

Primary LanguageTypeScript

Product Gallery API

Esta es una API para gestionar una galería de productos utilizando NestJS, Prisma, SQLite y JWT para la autenticación. La API permite crear, leer, actualizar y eliminar productos, con rutas protegidas para la creación y edición de productos.

Requisitos

  • Node.js (versión 20 o superior)
  • npm (versión 10 o superior)

Instalación

Sigue los pasos a continuación para instalar y ejecutar la aplicación:

  1. Clonar el repositorio:

    git clone git@github.com:IonVillarreal/product-gallery.git
cd product-gallery

  2. Instalar las dependencias:

    npm install

  3. Configurar el archivo .env:

    • Crea un archivo .env en el directorio raíz del proyecto y agrega la siguiente línea: 
      JWT_SECRET=your_jwt_secret_key

  4. Configurar Prisma:

    • Asegúrate de que el archivo prisma/.env contenga la URL de la base de datos apuntando a file:./dev.db.

  5. Inicializar la base de datos:

    npx prisma migrate dev --name init

  6. Ejecutar el script de seed para agregar datos de prueba:

    npm run seed

  7. Iniciar la aplicación:

    npm run start:dev

  8. Acceder a la documentación de la API:

    • Abre tu navegador y navega a http://localhost:3000/api para ver la documentación de Swagger.

Uso

Autenticación

La API utiliza JWT para la autenticación. Para acceder a las rutas protegidas, primero debes iniciar sesión y obtener un token.

Registro de usuario

POST /api/auth/register

Cuerpo de la solicitud:

{
  "email": "user@example.com",
  "password": "yourpassword"
}

Inicio de sesión

POST /api/auth/login

Cuerpo de la solicitud:

{
  "email": "user@example.com",
  "password": "yourpassword"
}

Respuesta:

{
  "access_token": "your_jwt_token"
}

Gestión de productos

Crear producto

POST /api/products

Encabezados:

Authorization: Bearer your_jwt_token

Cuerpo de la solicitud:

{
  "name": "Product Name",
  "description": "Product Description",
  "price": 99.99
}

Obtener todos los productos

GET /api/products

Obtener un producto por ID

GET /api/products/:id

Actualizar producto

PATCH /api/products/:id

Encabezados:

Authorization: Bearer your_jwt_token

Cuerpo de la solicitud:

{
  "name": "Updated Product Name",
  "description": "Updated Product Description",
  "price": 149.99
}

Eliminar producto

DELETE /api/products/:id

Encabezados:

Authorization: Bearer your_jwt_token