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 ntgnn/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应用程序或创建一个新的
安装ntgnn/swagger包
运行init命令
运行copy-assets命令
运行generate-docs命令
提供服务并浏览路由/docs

ntgnn / swagger

维护者

详细信息

README

快速设置