juststeveking/laravel-redoc

使用 OpenAPI 和 Redoc 的 Laravel 简单 API 文档包

维护者

详细信息

github.com/JustSteveKing/laravel-redoc

源代码

问题

资助包维护！
JustSteveKing

安装量: 101 566

依赖项: 1

建议者: 0

安全性: 0

星标: 73

观察者: 3

分支: 11

开放问题: 1

2.1.0 2024-06-11 09:25 UTC

Requires

Requires (Dev)

MIT 37fd925fae7dad31ec4259c032b5977d4970addc

documentationapilaravelopenapiredoc

This package is auto-updated.

Last update: 2024-09-11 10:04:19 UTC

README

Latest Version on Packagist Software License Build Status Total Downloads

通过在 Laravel 应用中使用您的 OpenAPI 文档轻松发布您的 API 文档。

安装

您可以通过 composer 安装此包

composer require juststeveking/laravel-redoc

启用 Alfred

要启用文档上的 Alfred，请访问：https://www.treblle.com/product/alfred 或 https://docs.treblle.com/treblle/ai-assistant

配置

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

php artisan vendor:publish --provider="JustSteveKing\Laravel\LaravelRedoc\RedocServiceProvider" --tag="config"

这是已发布配置文件的内容

return [
    'path' => [
        'name' => env('REDOC_PATH_NAME', 'docs'),
        'url' => env('REDOC_PATH_URL', 'api/docs'),
    ],
    
    'alfred' => [
        'enabled' => env('REDOC_ALFRED', true),
        'project_id' => env('ALFRED_PROJECT_ID', null),
        'api_key' => env('ALFRED_API_KEY', null),
    ],

    'openapi' => [
        'path' => env('REDOC_OPENAPI_PATH', 'http://petstore.swagger.io/v2/swagger.json')
    ],

    'config' => [
        'search' => false,

        'hostname' => false,

        'loading' => false,

        'menu' => true,

        'scrollbars' => true,

        'trust' => true,
    ]
];

贡献

请参阅CONTRIBUTING 和 CODE_OF_CONDUCT 以获取详细信息。

安全性

如果您发现任何与安全相关的问题，请通过电子邮件 juststevemcd@gmail.com 反馈，而不是使用问题跟踪器。

鸣谢

许可证

MIT 许可证 (MIT)。请参阅许可证文件获取更多信息。