README

使用你的 OpenAPI 文档在 Laravel 中渲染现代 API 参考

安装

您可以通过 composer 安装此包

composer require scalar/laravel

您可以使用以下命令发布配置文件

php artisan vendor:publish --tag="scalar-config"

可选，您可以使用以下命令发布视图

php artisan vendor:publish --tag="scalar-views"

用法

您需要 OpenAPI/Swagger 文档来使用 Scalar 渲染您的 API 参考。以下是一些帮助生成这些文档的包：

完成之后，您可以将其传递给 Scalar。只需确保它是公开可访问的 URL。

<?php

// config/scalar.php

return [
    // …

    'url' => '/openapi.yaml',

    // …
]

授权

Scalar API 参考可以通过 /scalar 路由访问。默认情况下，任何人都可以访问此路由。但是，在您的 App\Providers\AppServiceProvider.php 文件中，您可以覆盖 gate 定义。这个授权 gate 控制非本地环境中对 Scalar 的访问。您可以根据需要修改这个 gate 来限制对您的 Horizon 安装的访问。

<?php

namespace App\Providers;

use Illuminate\Support\Facades\Gate;
use Illuminate\Support\ServiceProvider;

class AppServiceProvider extends ServiceProvider
{
    public function boot(): void
    {
        Gate::define('viewScalar', function ($user) {
            return in_array($user->email, [
                //
            ]);
        });
    }
}

测试

composer test

变更日志

请参阅 CHANGELOG 了解最近发生了什么更改。

贡献

欢迎贡献。

鸣谢

许可

MIT 许可证 (MIT)。有关更多信息，请参阅许可文件。

scalar / laravel

维护者

详细信息

README

安装

用法

授权

测试

变更日志

贡献

鸣谢

许可