Skip to content

Latest commit

 

History

History
132 lines (101 loc) · 3.78 KB

README.md

File metadata and controls

132 lines (101 loc) · 3.78 KB
Raw

Gallery API

El objetivo principal de este proyecto es desarrollar una API especializada en la gestión de una galería de imágenes. La API proporciona una variedad de endpoints que permiten llevar a cabo diversas operaciones, tales como obtener un listado completo de imágenes, recuperar información de una imagen específica, crear nuevos registros de imágenes y eliminar registros de imágenes previamente almacenadas.

Pre-requisitos 📋

Para la correcta ejecución de este proyecto, necesitas tener las siguientes tecnologías instaladas en tu ordenador.

  • PHP 8.2.12
  • Composer 2.7.2
  • MySQL o MariaDB

Instalación 🔧

  1. Clona este proyecto.
git clone https://github.com/JoanArturo/gallery-api.git
  1. Instala las dependencias de PHP con composer.
composer install

  1. Crea una nueva base de datos con tu gestor de base de datos preferido. Como sugerencia podrías crear una base de datos llamada gallery_app.

  2. Crea una copia del archivo env.example, renombralo como .env y configura las variables de entorno correspondientes, preferiblemente las variables para la conexión a la base de datos y la variable FILESYSTEM_DISK con el valor public.

APP_NAME=Gallery
APP_ENV=local
APP_KEY=
APP_DEBUG=true
APP_URL=http://localhost:8000

LOG_CHANNEL=stack
LOG_DEPRECATIONS_CHANNEL=null
LOG_LEVEL=debug

DB_CONNECTION=mysql
DB_HOST=127.0.0.1
DB_PORT=3306
DB_DATABASE=tu_base_de_datos
DB_USERNAME=tu_username
DB_PASSWORD=tu_password

BROADCAST_DRIVER=log
CACHE_DRIVER=file
FILESYSTEM_DISK=public
QUEUE_CONNECTION=sync
SESSION_DRIVER=file
SESSION_LIFETIME=120

MEMCACHED_HOST=127.0.0.1

REDIS_HOST=127.0.0.1
REDIS_PASSWORD=null
REDIS_PORT=6379

MAIL_MAILER=smtp
MAIL_HOST=mailpit
MAIL_PORT=1025
MAIL_USERNAME=null
MAIL_PASSWORD=null
MAIL_ENCRYPTION=null
MAIL_FROM_ADDRESS="hello@example.com"
MAIL_FROM_NAME="${APP_NAME}"

AWS_ACCESS_KEY_ID=
AWS_SECRET_ACCESS_KEY=
AWS_DEFAULT_REGION=us-east-1
AWS_BUCKET=
AWS_USE_PATH_STYLE_ENDPOINT=false

PUSHER_APP_ID=
PUSHER_APP_KEY=
PUSHER_APP_SECRET=
PUSHER_HOST=
PUSHER_PORT=443
PUSHER_SCHEME=https
PUSHER_APP_CLUSTER=mt1

VITE_APP_NAME="${APP_NAME}"
VITE_PUSHER_APP_KEY="${PUSHER_APP_KEY}"
VITE_PUSHER_HOST="${PUSHER_HOST}"
VITE_PUSHER_PORT="${PUSHER_PORT}"
VITE_PUSHER_SCHEME="${PUSHER_SCHEME}"
VITE_PUSHER_APP_CLUSTER="${PUSHER_APP_CLUSTER}"
  1. Genera una APP_KEY.
php artisan key:generate
  1. Crea un enlace simbólico (un atajo) a la carpeta storage.
php artisan storage:link
  1. Ejecuta las migraciones.
php artisan migrate
  1. Ejecuta el proyecto laravel.
php artisan serve

Construido con 🛠️

Endpoints 🔗

A continuación se detallan los endpoints disponibles en la API:

Método Ruta Descripción
GET /api/v1/images Devuelve un array de imágenes.
POST /api/v1/images Guarda una imagen utilizando la información enviada dentro del body de la solicitud.
GET /api/v1/images/{image} Devuelve el objeto de una imagen con el id especificado.
DELETE /api/v1/images/{image} Elimina una imagen con el id especificado.

Autor 🖋️