API Gestión de Cursos y Estudiantes

Acerca de

Bienvenido a la documentación de la API de Cursos. Esta API permite gestionar cursos y estudiantes incluyendo operaciones para crear, leer, actualizar y eliminar.

Tabla de Contenidos

• API Gestión de Cursos y Estudiantes
  • Acerca de
  • Tabla de Contenidos
  • Requisitos
  • Instalación
  • Configuración
  • Ejecución
  • Endpoints
    • Cursos
    • Estudiantes
    • Inscripciones
  • Autenticación
  • Pruebas con Postman

---

Requisitos

• PHP >= 8.1
• Composer
• MySQL o PostgreSQL
• Laravel >= 10

Instalación

1. Clona el repositorio:

   git clone https://github.com/tu-usuario/api-cursos.git
   cd api-cursos

2. Instala las dependencias:

   composer install

3. Copia el archivo de entorno y configura tus variables:

   cp .env.example .env

4. Genera la clave de la aplicación:

   php artisan key:generate

Configuración

Edita el archivo .env para configurar la conexión a la base de datos:

DB_CONNECTION=mysql
DB_HOST=127.0.0.1
DB_PORT=3306
DB_DATABASE=api_cursos
DB_USERNAME=usuario
DB_PASSWORD=contraseña

Ejecuta las migraciones:

php artisan migrate

Ejecución

Inicia el servidor de desarrollo:

php artisan serve

La API estará disponible en http://localhost:8000.

Endpoints

Cursos

• GET /api/courses — Listar todos los cursos
• GET /api/courses/{id} — Obtener detalles de un curso
• POST /api/courses — Crear un nuevo curso
• PUT /api/courses/{id} — Actualizar un curso existente
• DELETE /api/courses/{id} — Eliminar un curso

Estudiantes

• GET /api/students — Listar todos los estudiantes
• GET /api/students/{id} — Obtener detalles de un estudiante
• POST /api/students — Crear un nuevo estudiante
• PUT /api/students/{id} — Actualizar un estudiante existente
• DELETE /api/students/{id} — Eliminar un estudiante

Inscripciones

• GET /api/enrollments — Listar todas las inscripciones
  • GET /api/enrollments?student_id=1 — Listar cursos donde está inscrito un estudiante
  • GET /api/enrollments?course_id=1 — Listar estudiantes inscritos en un curso
• POST /api/enrollments — Crear una nueva inscripción
• DELETE /api/enrollments/{id} — Eliminar una inscripción

Autenticación

La API utiliza autenticación basada en tokens (Laravel Sanctum).

1. Registra un usuario:

   POST /api/register

2. Inicia sesión para obtener un token:

   POST /api/login

El token debe enviarse en el header Authorization: Bearer {token} en las peticiones protegidas.

Pruebas con Postman

Para facilitar las pruebas de la API, se incluye un archivo de colección de Postman en el repositorio: Gestión de Cursos y Estudiantes.postman_collection.json.

1. Abre Postman y selecciona Importar.
2. Elige el archivo Gestión de Cursos y Estudiantes.postman_collection.json ubicado en la raíz del proyecto.
3. Actualiza las variables de entorno (por ejemplo, la URL base y el token de autenticación) según tu configuración local.
4. Ejecuta las solicitudes incluidas para probar los diferentes endpoints de la API.

Esto te permitirá validar rápidamente el funcionamiento de la API y explorar sus funcionalidades.