README

对于 Laravel 4，请使用 0.3 分支！

Laravel 5 的 Swagger

此包将 swagger-php 和 swagger-ui 结合成一个对 Laravel 友好的包。

当您以调试模式运行应用程序时，Swagger 将扫描您的 Laravel 应用程序文件夹，生成 swagger json 文件并将它们存放到 docs-dir 文件夹（默认为 "docs"）中。然后文件由 swagger-ui 在 api-docs 目录下提供。

安装

composer require latrell/swagger dev-master

使用 composer update 更新包或使用 composer install 安装。

要使用 Swagger 服务提供器，您必须在引导 Laravel 应用程序时注册提供器。实际上有两种方法可以做到这一点。

在 config/app.php 中找到 providers 键并注册 Swagger 服务提供器。

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

运行 php artisan vendor:publish 将 swagger-ui 推送到您的公共文件夹并发布配置文件。

配置文件 config/latrell-swagger.php 是您与 Swagger 交互的主要方式。