如何为 swagger 的所有 URL 添加 L5-Swagger 前缀？

Question

我正在使用 L5-Swagger 通过 Laravel 在 PHP 中构建我的 swagger。我们能否为所有端点 URL 加上前缀，以免每个端点都重复它们？此示例中通常为前缀“/api/v1”：

我在

config.l5-swagger.php

中看到了几个选项，但我尝试了很多方法但都失败了。

Answer 1

将其添加到控制器顶部：

/**
 *
 * @OA\Info(
 *     version="1.0.0",
 *     title="Organization",
 *     description="test description",
 *     @OA\Contact(
 *         name="test",
 *         email="test@test"
 *     ),
 * ),
 * @OA\Server(
 *     url="/api/v1",
 * ),
 */
class YourController extends Controller

然后你必须像这个文档一样为你的所有控制器方法进行设置。

建议： 如果您使用 PHP 8.1 或更高版本 Laravel 8.x 或更高版本 而不是使用

L5-Swagger

使用

dedoc/scamble

它会自动为您生成文档，并且它位于 swagger

之上

更多信息