sargilla / swagger by sargilla

Integrador de Swagger 3 a Laravel 5
505
3
3
Package Data
Maintainer Username: sargilla
Maintainer Contact: sargilla@gmail.com (santiago argilla)
Package Create Date: 2017-06-13
Package Last Update: 2021-06-18
Home Page:
Language: PHP
License: MIT
Last Refreshed: 2024-04-18 15:23:35
Package Statistics
Total Downloads: 505
Monthly Downloads: 55
Daily Downloads: 10
Total Stars: 3
Total Watchers: 3
Total Forks: 1
Total Open Issues: 0

Swagger (Integrador de Swagger para Laravel 5)

Este paquete integra Swagger-php y Swagger UI a Laravel 5. Cuando esta en modo debug, Swagger escaneará la carpeta app (o cualquier carpeta debajo de "app-dir" y se puede cambiar desde la configuración), genera un archivo json y lo pone en el directorio "doc-dir" (/docs).

Instalación

  • Ejecute composer require sargilla/swagger --dev en el directorio de laravel
  • AgregarSargilla\Swagger\SwaggerServiceProvider::class a app/config/app.php .
  • Ejecutar php artisan vendor:publish --tag=public para enviar swagger-ui a la carpeta pública (podes encontrala en public/vendor/swagger).
  • Opcional: ejecuta php artisan vendor:publish --tag=config para copiar las configuraciones por defecto en el directorio de configuraciones de su aplicación.
  • Opcional: ejecuta php artisan vendor:publish --tag=views para copiar el archivo de la vista a resources/views/vendor/swagger.

Ejemplos (usando la configuración por defecto)

  • www.tusitio.com/docs <- Ver el .json generado por Swagger
  • www.tusitio.com/api/docs <- Acceder a Swagger UI