README

此包是 Swagger-php 的包装器，并使其与Lumen/Laravel的集成变得容易。

使用方法

安装

通过Composer

在您的 composer.json 中添加新包的信息

    "require": {
    ...
        "paunin/laswagger": ">=1.0.0"
    ...
    }

Composer安装完成后，注册服务提供者

Lumen应用程序

$app->register(Laswagger\Providers\LumeSwaggerServiceProvider::class);

Laravel应用程序：尚不支持。

现在您可以使用laswagger了

运行 php artisan swagger:generate file_name [base_host]：生成Swagger API文档。
访问 /swagger/api-docs（默认路由配置）以查看JSON格式的Swagger API文档

默认配置

<?php
return [
    'routes' => [
        'prefix' => 'swagger',
        'cors'   => false
    ],
    'api' => [
        'directories' => [base_path('app')],
        'excludes' => [],
        'host' => null
    ]
];

自定义配置

要更改默认配置，您可以将 config/laswagger.php 中的配置模板复制到您的应用程序的 config 目录，并根据需要修改。有关更多信息，请参阅Lumen文档中的配置文件部分。

测试

./vendor/phpunit/phpunit/phpunit

查看测试结果在 ./build

paunin / laswagger

维护者

详细信息

README

使用方法

安装

默认配置

自定义配置

测试