laravel api

Proyecto back-end de Laravel/PHP

Enlace a la compilación de producción en vivo

Bienvenido a otro de mis proyectos API. Para este proyecto, escribí, probé e implementé una aplicación Laravel como parte de un proyecto completo, aprovechando muchas de las poderosas características del marco, que incluyen:

• fachadas y funciones auxiliares;
• autenticación y autorización de usuarios;
• siembra de bases de datos;
• Generador de consultas ORM elocuente;
• Herramientas avanzadas de prueba de API.

¿Para qué es?

Esta API procesa datos relacionados con los usuarios/candidatos y sus exámenes. Por ejemplo, permite a un usuario ver información sobre lugares/ubicaciones de exámenes, fechas, nombres de candidatos, etc.

Una nota importante sobre el acceso

• Asegúrese de incluir un encabezado HTTP Aceptar: aplicación/json con todas las solicitudes a la API.
• La mayoría de las funciones de la API solo están disponibles para usuarios de nivel administrador. Para experimentar con esta aplicación, puede registrarse para obtener una nueva cuenta utilizando un correo electrónico que termine en @v3.admin , que le otorgará privilegios completos de administrador.

 // To sign up as an admin, make a POST request to https://laravel-php-api.vercel.app/public/api/signup and include a request body in the following format:

        {
		    "name" : " Anna Torpid " ,
		    "email" : " [email protected] " ,
		    "password" : " dfbdf9suhfd9shf " ,
		    "password_confirmation" : " dfbdf9suhfd9shf "
        }

// To login, make a POST request to https://laravel-php-api.vercel.app/public/api/login and include a request body in the following format:

        {
		    "email" : " [email protected] " ,
		    "password" : " dfbdf9suhfd9shf "
        }

// The above POST request returns this response. Make sure to include the returned token in the authorisation header of all future requests.

        {
	        "user" : {
		        "id" : 11 ,
		        "name" : " Anna Torpid " ,
		        "email" : " [email protected] "
	        },
	        "token" : " 5|tAujbY9luWTKquNEruGHU7soCXp7MuzVb8WR0VO9 "
        }

Una vez que se haya registrado o iniciado sesión, se le entregará un token API que deberá adjuntar a los encabezados de su solicitud para garantizar el acceso CRUD completo.

Puntos finales disponibles

Para acceder a cada extremo, agregue el fragmento de URI al extremo raíz. Puede ver más detalles visitando el punto final raíz.

Recurso	Descripción	Autenticación/autorización
PUBLICAR /registro	Crear nueva cuenta.	Público
ENVIAR/iniciar sesión	Inicie sesión en una cuenta existente.	Público
OBTENER /cerrar sesión/{id}	Cerrar sesión (revoca tokens).	Sólo usuarios registrados
OBTENER /exámenes	Muestra una lista de todos los exámenes. Incluye 5 parámetros de consulta opcionales .	Sólo administrador
OBTENER /exámenes/{id}	Hágase un examen específico.	Sólo puedo ver mis propios exámenes.
PUT /exámenes/{id}	Modificar un examen específico.	Solo puedo editar mis propios exámenes
OBTENER /exámenes/búsqueda/{nombre}	Búsqueda de subcadenas para un candidato específico.	Sólo administrador
BORRAR /exámenes/{id}	Eliminar examen.	Sólo se puede eliminar el propio examen.
OBTENER /usuarios	Obtener lista de todos los usuarios.	Sólo administrador
OBTENER /usuarios/{id}/exámenes	Obtener una lista de todos los exámenes para un usuario	Sólo puedo ver mis propios exámenes.

Características clave del producto

• Implementado en Vercel como una 'función sin servidor', utilizando un tiempo de ejecución PHP para manejar la configuración de las aplicaciones.
• La implementación de producción está vinculada a una base de datos PSQL activa alojada de forma remota con un proveedor diferente.
• Sintaxis expresiva específica de Laravel con encadenamiento de métodos extenso, lo que permite una estructura de código más concisa.
• Desarrollado mediante pruebas utilizando PHPUnit y la fluida sintaxis JSON de Laravel (basada en cierres y la clase AssertableJson).
• Pruebas automatizadas con un flujo de trabajo CI/CD configurado mediante Github Actions.
• Diseñado utilizando un patrón MVC orientado a objetos
• Servicios de autenticación implementados usando Sanctum
  • Los usuarios pueden registrarse e iniciar sesión.
  • Solo los usuarios con tokens API válidos pueden acceder a las rutas protegidas.
• Servicios de autorización implementados utilizando las puertas de Laravel, un enfoque de autorización basado en cierre.
  • Ciertas acciones solo están permitidas a usuarios con roles específicos, como el estado de administrador.
• Relaciones y restricciones de esquema definidas utilizando las herramientas de relaciones de Eloquent ORM
• Base de datos SQLite utilizada para desarrollo y pruebas.

Archivos y carpetas principales en el directorio del proyecto.

• ./app contiene la lógica central de la aplicación.
  • /app/Http/Controllers contiene la lógica de manejo de solicitudes.
  • app/Models contiene todas las clases de modelo y es donde especificamos todos los campos que se pueden completar.
  • app/Providers contiene clases que inician toda la aplicación.
• ./routes/api.php es donde definimos de manera concisa todas nuestras rutas (puntos finales).
• ./tests/Feature contiene todas las pruebas de integración para la aplicación.
• ./config/database.php le permite configurar los ajustes de conexión de su base de datos.
• ./database es otra carpeta muy importante.
  • ./database/factories contiene las clases de fábrica que se utilizan para inicializar las bases de datos.
  • ./database/migrations nos permite modificar nuestro modelo de datos
  • ./databse/seeders contiene clases que inicializan la base de datos a través de fábricas.

Ejecutar el proyecto en su entorno local

Primero, asegúrese de tener PHP y Composer instalados en su máquina.

Requisitos mínimos de versión: PHP ^8.1 ; Compositor 2.5.4 .

1. Bifurca y clona el repositorio.

2. cd en el repositorio y ejecute estos comandos CLI:

    composer update
    composer install
   

3. Cambie el nombre de su archivo .env.example a .env , elimine las variables para la conexión mysql predeterminada y asegúrese de agregar las siguientes 3 variables:

    DB_CONNECTION=sqlite
    DB_FOREIGN_KEYS=true
    USE_SQLITE_SYNTAX=like
    DB_DATABASE= this needs to be the absolute path to the sqlite database located in ./database/database.sqlite, e.g. /home/username/mydocuments/laravel-api/database/database.sqlite*
   

4. Para activar el servidor de desarrollo local, ejecute el comando Artisan CLI:

    php artisan serve
   

5. Para ejecutar el traje de prueba, ejecute el comando CLI de Artisan:

    php artisan test