README

又一个用于使用 OpenApi/Swagger 记录基于 Laravel 的 API 的工具。此包深受 DarkaOnLine/L5-Swagger 的启发，并且还封装了 zircote/swagger-php 和 swagger-api/swagger-ui，但由于我们对某些特定要求以及处理 swagger-ui 静态资源时遇到的一些问题，我们决定采取不同的方法。此包仅支持 OpenAPI 注释、Swagger 3.0 和 Laravel >=5.6。

要在您的 Laravel 应用中安装此包，只需使用 composer

$ composer require quattror/swagger

加载此包后，它将为您提供 3 个控制台命令：init、generate-docs 和 copy-assets

Init: 此命令将设置配置文件（config/swagger.php）并在您的 app/Http 中创建一个用于 swagger 相关文件的文件夹。您应该仅在安装时运行此命令一次。

$ php artisan swagger:init

Copy-Assets: 此命令会将 swagger-ui 相关的文件复制到 public 文件夹。您应该仅在安装时运行此命令一次。

$ php artisan swagger:copy-assets

Generate-Docs: 此命令将扫描您的 PHP 文件并生成用于 swagger ui 的 json 规范文件。json 文件将位于 public 文件夹内。您应该每次想要更新 json 文件时运行此命令，例如在注释控制器之后。

$ php artisan swagger:generate-docs

快速设置

前往现有的 Laravel 应用或创建一个
安装 quattror/swagger 包
运行 init 命令
运行 copy-assets 命令
运行 generate-docs 命令
运行应用并浏览路由 /docs

quattror / swagger

维护者

详细信息

README

快速设置