latrell/swagger

Swagger for Laravel 5

Installs: 5 502

Dependents: 0

Stars: 15

Watches: 1

Forks: 5

Open Issues: 2

Language: JavaScript

1.0.0 2015-03-08 07:20 UTC

README

For Laravel 4, please use the 0.3 branch!

Swagger for Laravel 5

This package combines swagger-php and swagger-ui into one Laravel-friendly package.

When you run your app in debug mode, Swagger will scan your Laravel app folder, generate swagger json files and deposit them to the docs-dir folder (default is "docs"). Files are then served by swagger-ui under the api-docs director.

Installation

composer require latrell/swagger dev-master

Update your packages with composer update or install with composer install.

Usage

To use the Swagger Service Provider, you must register the provider when bootstrapping your Laravel application. There are essentially two ways to do this.

Find the providers key in config/app.php and register the Swagger Service Provider.

    'providers' => [
        // ...
        'Latrell\Swagger\SwaggerServiceProvider',
    ]

Run php artisan vendor:publish to push swagger-ui to your public folder and publish the config file.

Config file config/latrell-swagger.php is the primary way you interact with Swagger.

Example