README

此包会扫描您的Laravel项目路由，并自动为您生成Swagger 3.0文档。如果您在控制器动作中注入表单请求类作为请求验证，它还将为具有它们的每个请求生成参数。它会考虑请求是GET/HEAD/DELETE还是POST/PUT/PATCH请求，并尽可能猜测它应该生成的参数对象类型。如果您路由包含路径参数，它还将生成路径参数。

安装

在使用此包之前，请先安装Laravel的swagger： https://github.com/DarkaOnLine/L5-Swagger ：)

可以通过在项目根目录中运行 composer require hovsepyan/lara-autoswag 来轻松安装此包。

如果您正在运行Laravel版本 < 5.5，请确保将 Hovsepyan\LaravelSwagger\SwaggerServiceProvider::class 添加到 config/app.php 文件中的 providers 数组中。

这将注册一个 artisan 命令，您可以使用它。

您还可以通过在项目根目录中运行 php artisan vendor:publish --provider "L5Swagger\L5SwaggerServiceProvider" 来覆盖应用程序提供的默认配置，并在新创建的 config/laravel-swagger.php 文件中更改配置。

使用方法

生成Swagger文档很简单，只需在项目根目录中运行 php artisan laravel-swagger:generate 即可。请注意，该命令将仅在控制台打印输出。如果您想将文档保存到文件中，可以重定向输出，例如： php artisan laravel-swagger:generate > public/docs/swagger.json

如果您想为路由子集生成文档，可以使用 --filter 传递过滤器，例如： php artisan laravel-swagger:generate --filter="/api"

hovsepyan / lara-autoswag

维护者

详细信息

README

安装

使用方法