README

Lumen Swagger

使用 swag 生成 API 文档。

composer require benjamincrozat/lumen-swagger

在您的 bootstrap/app.php 文件中添加以下行

$app->register(BC\LumenSwagger\ServiceProvider::class);

如果您希望在此包上运行 Laravel，可以通过 Composer 安装它。由于自动包发现功能，您只需安装即可完成，非常方便。

composer require benjamincrozat/lumen-swagger

一旦您注解了您的模型和控制器（在此处查看文档），使用命令非常简单

php artisan swagger

Generated at "/path/to/project/swagger.json"

您也可以指定一个自定义路径

php artisan swagger --path whatever/documentation.json

Generated at "/path/to/project/whatever/documentation.json"

甚至更改扫描位置

php artisan swagger --scan whatever

Generated at "/path/to/project/swagger.json"

在我看来，注释对此用例非常好，但也很杂乱。在代码中编写 API 规范并不是最干净的做法。您的文件很快就会变得不必要地臃肿。在 Lumen Boilerplate 中，我选择了单个文件 config/swagger.php。只需运行以下命令来扫描 config 目录

php artisan swagger --scan config