Tema 16 · Despliegue & Swagger

16. Documentación Interactiva con OpenAPI / Swagger y Despliegue en VPS

Genera especificaciones OpenAPI interactivas con Swagger UI y despliega tu API en un servidor VPS Linux con Nginx, PHP-FPM, SSL y colas.

Una API sin Documentación es una API Invisible

Para que otros desarrolladores y equipos consuman tu API sin fricción, el estándar de la industria es la especificación OpenAPI (Swagger). En Laravel podemos generar documentación interactiva y pruebas en vivo (con botones "Try it out") utilizando atributos de PHP 8 y paquetes como dedoc/scramble o l5-swagger.

Despliegue de APIs en Producción sobre un Servidor VPS Linux

Llevar una API de Laravel a producción en un Servidor VPS (como los VPS de OVH) requiere optimizaciones estrictas que no se ejecutan en local:

  • php artisan config:cache: Compila todos los archivos de configuración en uno solo.
  • php artisan route:cache: Compila el árbol de rutas en un único array serializado, reduciendo el arranque de rutas a microsegundos.
  • php artisan event:cache: Cachea eventos y escuchadores.
  • php artisan optimize: Ejecuta todas las optimizaciones de golpe.

Gestión de Trabajadores en Segundo Plano (Queues)

Tareas pesadas como envío de correos de bienvenida, procesamiento de reportes o generación de PDFs nunca deben ejecutarse sincrónicamente bloqueando la respuesta HTTP de la API. Se despachan como Jobs asíncronos a una cola (Queue) administrada de forma permanente por Supervisor en el servidor VPS.

⚡ Script de Despliegue Automatizado para API Laravel en Servidor VPS

Secuencia de comandos de producción para actualizar la API sin tiempo de inactividad:

despliegue-api-vps.sh
Solo lectura
#!/bin/bash
# Script de Despliegue Continuo para API Laravel en Servidor VPS Linux
set -e

echo "🚀 Iniciando despliegue de API RESTful..."

# 1. Poner la aplicación en modo mantenimiento temporal
php artisan down --render="errors::503" --secret="clave-acceso-deploy-2026"

# 2. Obtener los últimos cambios desde GitHub
git pull origin main

# 3. Instalar dependencias de producción sin paquetes de desarrollo
composer install --no-dev --optimize-autoloader --no-interaction

# 4. Ejecutar migraciones de base de datos de forma segura
php artisan migrate --force

# 5. Recompilar y cachear configuraciones, rutas y eventos
php artisan optimize:clear
php artisan optimize

# 6. Reiniciar los workers de colas en segundo plano con Supervisor
php artisan queue:restart

# 7. Volver a poner la API en línea
php artisan up

echo "✅ Despliegue de la API completado exitosamente!"
🧠
Mini-Quiz de Retención
Comprueba tu comprensión antes de pasar a la siguiente lección
1 Pregunta
Pregunta 1
¿Qué comando de Artisan compila y optimiza todas las rutas y configuraciones de una API Laravel para producción en el servidor VPS?
🦉
¿Tienes dudas con este tema?
Sócrates AI puede darte analogías y explicarte este código paso a paso.

🚀 ¿Quieres dominar APIs RESTful con Laravel, Resources & Sanctum y crear proyectos reales?

Aprende arquitectura limpia, desarrollo web moderno, buenas prácticas y despliegue en producción con nuestro Bootcamp Fullstack Developer con mentorías en vivo.

🏛️ Autoría y Propiedad Intelectual: Obra educativa original de Juan Sebastián Amador para Kilopolis Academia, estructurada sobre las especificaciones y estándares abiertos del W3C, el estándar vivo de WHATWG y la documentación oficial de código abierto. © Todos los derechos reservados.