README

Laravel Redoc

本包提供了一种使用 OpenAPI 和 Redoc 渲染 API 文档的简单方法。

您可以通过 composer 安装此包

composer require 3sidedcube/laravel-redoc

默认情况下，文档在 /docs/api 提供服务，并将从项目根目录下的 openapi 文件夹加载 openapi.json 文件。

您可以通过设置 redoc.path 配置选项来更改用于提供文档的路径。

如果您想更改 openapi.json 文件所在的目录，您可以更新 redoc.directory 配置选项。

Laravel Redoc 支持渲染多个版本的文档。如果您想提供不同的文档版本，您可以在 redoc.path 配置选项中包含 {version}，例如 docs/{version}/api。这将然后从配置的目录加载 {version}.json 文件。

如果您想替换文档中的“变量”，您可以使用 redoc.variables 配置选项。

例如，如果您想动态地将服务器 URL 设置为给定环境，您可以配置以下变量

'variables' => [
    'server_url' => env('APP_URL'),
],

现在，当您在 OpenAPI 定义中使用 :server_url 时，它将被替换为 APP_URL 的值。

composer test

请参阅 CHANGELOG 了解最近更改的详细信息。

请参阅 CONTRIBUTING 了解详细信息。

Laravel Redoc 是开源软件，许可协议为 MIT 协议。