README

简介

使用Composer安装包

composer require appwise-labs/laravel-docs

此包使用Laravel的自动发现:

如果由于某些原因这不起作用，您可以手动将ServiceProvider添加到您的config/app.php文件中。

'providers' => [
    //...
    AppwiseLabs\LaravelDocs\LaravelDocsServiceProvider::class
];

最后，使用以下命令发布默认配置文件config/laravel-docs.php：

php artisan laravel-docs:install

或

php artisan vendor:publish --provider="AppwiseLabs\LaravelDocs\LaravelDocsServiceProvider" --tag="config"

将您的openapi.yaml文件放在resources/docs/openapi.yaml中，并运行。此路径可以通过config/laravel-docs.php配置文件更改。默认路由查看您的文档是/docs。

默认情况下，文档仅在本地环境中可访问。您可以通过在App\Providers\AuthServiceProvider文件中使用权限canViewDocs来更改此设置。例如

Gate::define('canViewDocs', function ($user = null) {
    return true;
});