A continuación se describen los pasos básicos para configurar y usar la API REST provista en este repositorio.
Resumen:
- Autenticación:
POST /api/login(devuelve token) - Cierre sesión:
POST /api/logout(token requerido) - Recurso protegido:
registros(implemented:GET index,POST store)
- PHP 8.2+
- Composer
composer install
cp .env.example .env
php artisan key:generate
# Configura DB en .env y luego:
php artisan migrate
php artisan serve- Body JSON:
{ "email": "test@example.com", "password": "password" } - Headers:
Accept: application/json,Content-Type: application/json - Ejemplo curl:
curl -X POST http://localhost:8000/api/login \
-H "Accept: application/json" -H "Content-Type: application/json" \
-d '{"email": "test@example.com", "password": "password"}'- Respuesta:
{ "token": "<token>", "user": { ... } }
- Header:
Authorization: Bearer <token> - Respuesta:
{ "message": "Cierre de sesión exitoso" }
- Proporciona los registros del usuario autenticado.
- Headers:
Accept: application/json,Authorization: Bearer <token>
- Body JSON:
{ "nombre": "Nombre", "descripcion": "Opcional" } - Validaciones:
nombrerequired|string|max:255,descripcionnullable|string - Respuesta: 201 Created con el JSON del registro creado.
Nota:
Route::apiResource('registros', RegistroController::class)genera rutasshow,updateydestroy, pero enapp/Http/Controllers/Api/RegistroController.phpsolamente están implementadosindexystore.
- HTML en vez de JSON: Asegúrate de enviar
Accept: application/json. - 401: Token falta o inválido. Envía
Authorization: Bearer <token>. - 422: Validación; revisa nombres de campos y contenido.
- 500: Revisa
storage/logs/laravel.log.
The Laravel framework is open-sourced software licensed under the MIT license.