README

生成干净的HTML API文档。基于您的路由声明和过滤模式。

安装

composer require thunken/doc-doc-goose

添加

Thunken\DocDocGoose\DocDocGooseProvider::class,

到config/app.php的 providers 数组中

发布文件（如果您需要调整配置和视图）

php artisan vendor:publish --provider="Thunken\DocDocGoose\DocDocGooseProvider"

配置更改

return [
    'routes' => [
        'v1' => [
            'patterns' => [ 'api.v1.*' ],
            'rules' => [
                'headers' => [
                    'Authorization' => '<Your API Key>'
                ]
            ]
        ]
    ],
    'cache' => [
        'enabled' => true,
        'store' => 'file'
    ]
];

在这里，您可以管理版本、按版本管理头部和缓存功能。

缓存

默认启用缓存，并使用文件存储。您可以通过将 'enable' 设置为 false 来禁用它。

如果您的缓存文件在部署之间不持久化，文件缓存是最佳的缓存方法。这是确保您的文档在每个部署时都与您的API代码当前版本保持同步的好方法。您可以通过在所选缓存存储中重置 Extractor::cacheName 键来重现此行为。

外观

已在提供者中声明，因此这可能没有用。仍然，为了这样做，请添加

'Extractor' => Thunken\DocDocGoose\Facades\Extractor::class,

到config/app.php的外观数组中

用法

在视图中

只需注入

{!! \Extractor::renderMenu()  !!}

和/或在您的模板中

{!! \Extractor::renderContent()  !!}

。

使用原始提取器输出

$extractor = app(Extractor::class);
$extractor->extract();

/** @var array $docsAsArray */
$docAsArray = $extractor->toArray(); // returns an array

/** @var Collection $docsAsGroups */
$docsAsGroups = $extractor->toRaw(); // returns a Group Collection

@TODOs

目标描述
测试
测试
和测试

参考和感谢

广泛且明智地使用 https://github.com/mpociot/laravel-apidoc-generator 库（感谢）

thunken / doc-doc-goose

维护者

详细信息