Documenta tu API de Laravel en Postman fácilmente

Ahora puedes documentar tu API de Postman directamente desde Laravel utilizando el comando php artisan postman:generate, gracias al paquete Laravel Postman Documentation Generator . Este paquete automatiza la creación de colecciones de Postman basadas en tus rutas API, ahorrando tiempo y asegurando una documentación actualizada de forma instantánea.

¿Qué es Laravel Postman Documentation Generator?

Es un paquete open source que genera colecciones de Postman organizadas y listas para probar tus endpoints. Aprovecha las reglas de FormRequest, soporta autenticación Bearer y Basic Auth, permite agrupar rutas por prefijo o controlador, y mucho más. Ideal para equipos que actualizan sus APIs constantemente.

Instalación

Para instalarlo, ejecuta lo siguiente en tu proyecto Laravel:

composer require --dev yasin_tgh/laravel-postman

Luego, publica el archivo de configuración:

php artisan vendor:publish --provider="YasinTgh\LaravelPostman\PostmanServiceProvider" --tag="postman-config"

Uso básico

Genera la documentación de tu API con un solo comando:

php artisan postman:generate

Este comando crea el archivo JSON de la colección en storage/postman/api_collection.json, listo para importarse directamente en Postman.

Beneficios y funcionalidades

  • Genera documentación con un solo comando.
  • Agrupa rutas por prefijo, controlador o paths anidados.
  • Soporte integrado para autenticación (Bearer, Basic Auth, API Keys).
  • Generación automática del cuerpo de la solicitud según las reglas de FormRequest.
  • Configuración flexible para entornos y datos sensibles.

Alternativas libres

Además de Laravel Postman, existen otros generadores open source como Scribe y BeyondCode Laravel API Doc Generator , que también permiten crear documentación HTML y colecciones Postman.

Puedes usarlos mediante comandos como:

php artisan apidoc:generate

o

php artisan scribe:generate

Estas herramientas ofrecen más opciones de personalización y edición, útiles si tu proyecto requiere una documentación más detallada o visual.

Conclusión

Si quieres documentar tu API de Laravel para Postman de forma rápida y efectiva, el comando php artisan postman:generate junto con el paquete Laravel Postman Documentation Generator es una excelente opción. Mantén tu documentación siempre actualizada y facilita las pruebas con tu equipo de desarrollo.

Fuentes recomendadas