README

此包是 Swagger-php 的包装，使其易于与 Lumen/Larvarel 集成。

用法

安装

通过 Composer

在您的 composer.json 中添加新包的信息

    "repositories": [
        {
          "type": "vcs",
          "url": "git@gitlab.lzd.co:operations/laraswagger.git",
          "name": "lazada/database-minifier"
        }
    ],
    "require": {
        "lazada/laraswagger": ">=1.0.0"
    }

Composer 安装完成后，注册服务提供者

Lumen 应用程序

$app->register(Swagger\LaraSwagger\Providers\LumeSwaggerServiceProvider::class);

Laravel 应用程序：目前不支持。

现在您可以与 LaraSwagger 一同摇滚了

运行 php artisan swagger:generate file_name [base_host]：以生成 Swagger API 文档。
转到 /swagger/api-docs（默认路由配置）以查看 JSON 格式的 Swagger API 文档

默认配置

<?php
return [
    'routes' => [
        'prefix' => 'swagger'
    ],
    'api' => [
        'directories' => [base_path('app')],
        'excludes' => [],
        'host' => null
    ]
];

自定义配置

为了更改默认配置，您可以将 config/lara-swagger.php 中的配置模板复制到您的应用程序的 config 目录中，并根据您的需要进行修改。有关更多信息，请参阅 Lumen 文档中的配置文件部分。

测试

./vendor/phpunit/phpunit/phpunit

在 ./build 中查看测试结果

weburnit / swaggeravel

维护者

详细信息

README

用法

安装

默认配置

自定义配置

测试