jessekoska/swagger-lume

Swagger集成到Lumen 5

1.0.3 2016-05-09 09:50 UTC

This package is not auto-updated.

Last update: 2024-09-14 19:53:02 UTC


README

为Lumen 5的Swagger 2.0

此包是 Swagger-phpswagger-ui 的包装,以适应Lumen 5。

实现了Martin Abelson Sahlen版本的swagger-ui。

安装

    composer require "jessekoska/swagger-lume dev-master"
  • 打开您的 bootstrap/app.php 文件,并在

创建应用 部分(大约在第26行)取消注释这一行

     $app->withFacades();

注册容器绑定 部分之前添加这一行

     $app->configure('swagger-lume');

注册服务提供者 部分添加这一行

    $app->register(\SwaggerLume\ServiceProvider::class);
  • 运行 php artisan swagger-lume:publish-config 以发布配置(config/swagger-lume.php
  • 如有需要,进行配置更改
  • 运行 php artisan swagger-lume:publish 以发布所有内容

配置

  • 运行 php artisan swagger-lume:publish-config 以发布配置(config/swagger-lume.php
  • 运行 php artisan swagger-lume:publish-assets 将swagger-ui发布到您的公共文件夹(public/vendor/swagger-lume
  • 运行 php artisan swagger-lume:publish-views 将视图发布到(resources/views/vendor/swagger-lume
  • 运行 php artisan swagger-lume:publish 以发布所有内容
  • 运行 php artisan swagger-lume:generate 以生成文档

Swagger-php

实际的Swagger规范超出了本包的范围。SwaggerLume所做的是以Laravel友好的方式打包swagger-php和swagger-ui,并尝试使其易于提供。有关如何使用swagger-php的信息,请参阅此处。有关swagger-php的示例,请参阅此处