saargilla/swagger

Swagger 3 到 Laravel 5 的集成器

v1.5 2021-06-18 12:58 UTC

This package is auto-updated.

Last update: 2024-09-18 20:38:49 UTC


README

此包集成了 Swagger-php 和 Swagger UI 到 Laravel 5。当处于调试模式时,Swagger 会扫描 "app" 目录(或 "app-dir" 下的任何目录,并可从配置中更改),生成一个 json 文件并将其放置在 "doc-dir" 目录(/docs)中。

安装

  • 在 Laravel 目录下执行 composer require sargilla/swagger --dev
  • Sargilla\Swagger\SwaggerServiceProvider::class 添加到 app/config/app.php
  • 执行 php artisan vendor:publish --tag=public 将 swagger-ui 发布到公共目录(您可以在 public/vendor/swagger 中找到它)。
  • 可选:执行 php artisan vendor:publish --tag=config 将默认配置复制到应用程序的配置目录。
  • 可选:执行 php artisan vendor:publish --tag=views 将视图文件复制到 resources/views/vendor/swagger

示例(使用默认配置)