Laravel l5-swagger能否直接读取storage下的api-docs.json文件？

darkaonline/l5-swagger 5.6.*版本完全支持直接读取你放在storage目录下的api-docs.json文件，不用再手动写注解生成，按以下步骤操作即可：

1. 调整配置文件 #

先发布配置文件（没发布过的话执行这条命令）：

php artisan vendor:publish --provider "L5Swagger\L5SwaggerServiceProvider"

打开config/l5-swagger.php，修改两处配置：

• 把'docs_json'的路径指向你的本地文件：

  'docs_json' => storage_path('api-docs/api-docs.json'),
  

• 调整'routes'里的'api'项，对应前端请求的地址：

  'routes' => [
      'api' => 'docs/api-docs.json',
      // 其他配置保持原样
  ],
  

  这个'api'配置就是你报错里的http://127.0.0.1:8000/docs/api-docs.json，改完后前端就能正确找到文件路径。

2. 解决storage目录访问限制（可选） #

因为storage目录默认不对外公开，可能导致前端无法直接读取文件，这时在routes/web.php里加个路由来返回JSON内容：

use Illuminate\Support\Facades\File;
use Illuminate\Support\Facades\Response;

Route::get('/docs/api-docs.json', function () {
    $filePath = storage_path('api-docs/api-docs.json');
    if (!File::exists($filePath)) {
        abort(404);
    }
    $jsonContent = File::get($filePath);
    return Response::json(json_decode($jsonContent));
});

3. 验证效果 #

改完配置后直接访问http://127.0.0.1:8000/api/documentation，前端就能加载你预先准备好的api-docs.json了，不用再执行php artisan l5-swagger:generate命令。

额外提示 #

如果你的JSON文件本身缺少info字段（符合Swagger规范的JSON应该包含这个字段），想跳过@OA\Info()的校验，可以在config/l5-swagger.php里关闭校验：

'validator' => [
    'enabled' => false,
],

内容的提问来源于stack exchange，提问作者Starlight