Laravel怎么搭建自己的API文档_Laravel使用L5-Swagger生成OpenAPI规范【实战】

使用l5-swagger需确保laravel版本与包版本匹配、CORS启用、路由可扫描且控制器注释符合OpenAPI 3.0规范（@OA开头），并正确配置扫描路径、发布资源及清理缓存。

用 l5-swagger 生成 Laravel API 文档，核心前提是项目已启用 CORS、路由可被正确扫描，且控制器方法有符合 OpenAPI 规范的注释。否则生成的文档会缺失接口、参数错乱，甚至 php artisan l5-swagger:generate 直接报错退出。

安装 l5-swagger 并确认 Laravel 版本兼容性

l5-swagger 不是“装上就能用”的包，不同 Laravel 版本必须匹配对应 l5-swagger 版本，否则 ServiceProvider 注册失败或命令不可用：

• Laravel 9.x → 必须用 l5-swagger:^8.0（不支持 ^9.0）
• Laravel 10.x → 必须用 l5-swagger:^9.0（^8.0 会因 config_path() 调用方式变更而报错）
• 运行 composer require "darkaonline/l5-swagger:^9.0" 后，检查 config/app.php 是否自动注册了 L5SwaggerL5SwaggerServiceProvider::class；Laravel 9+ 使用自动发现，但若手动禁用了包发现，需补上

配置 swagger-php 注释并避免常见语法错误

文档质量完全取决于 PHPDoc 注释是否被 swagger-php 正确解析。Laravel 控制器里写错一个符号，整个接口就从文档中消失：

• 必须以 @OA 开头（不是 @SWG，那是旧版 Swagger 2.0 写法，l5-swagger:^8.0+ 只支持 OpenAPI 3.0+）
• @OAGet、@OAPost 等必须写在方法上方，且紧贴方法声明，中间不能有空行或其它注释
• 路径变量必须显式声明：@OAParameter(name="id", in="path", required=true, @OASchema(type="Integer"))；漏掉 in="path" 就不会出现在 URL 模板里
• 请求体用 @OARequestBody，不要用 @OAProperty 直接写在类上——后者只用于模型定义，不触发请求体渲染

@OAGet(     path="/api/users/{id}",     summary="获取单个用户",     @OAParameter(name="id", in="path", required=true, @OASchema(type="integer")),     @OAResponse(response="200", description="成功", @OAjsonContent(ref="#/components/schemas/User")) )

运行 generate 命令前必须清理缓存并检查路径扫描范围

php artisan l5-swagger:generate 默认只扫描 app/http/Controllers，如果你把 API 控制器放在 app/Http/Controllers/Api/V1 或用了 DDD 结构放在 app/Modules/User/Http/Controllers，它根本不会看一眼：

• 修改 config/l5-swagger.php 中的 paths → apis 数组，例如： ['app/Http/Controllers/Api/**/*.php']
• 执行前务必先运行 php artisan config:clear 和 php artisan cache:clear，否则旧配置残留会导致扫描路径未生效
• 如果提示 Unable to find a valid root element，大概率是某个控制器文件里混入了未闭合的 @OA 注释块，逐个排查比看报错行数更有效

访问文档页面时 404 或 UI 空白的典型原因

生成成功 ≠ 能访问。文档静态资源由 l5-swagger 发布到 public/vendor/l5-swagger，但以下情况会导致页面打不开：

• 没运行 php artisan vendor:publish --provider="L5SwaggerL5SwaggerServiceProvider"，导致前端资源缺失
• nginx/apache 没开启 index.php 隐式支持，访问 /api/documentation 时返回 404；应确保重写规则包含 try_files $uri $uri/ /index.php?$query_string;
• 使用了 Laravel Sanctum 或 Passport，但未在 config/l5-swagger.php 的 security 配置中声明 sanctum 方案，导致右上角 “Authorize” 按钮不显示 Token 输入框
• 浏览器控制台报 Failed to load Resource: the server responded with a status of 404 (Not Found) 对应 openapi.json，说明 l5-swagger:generate 没真正生成该文件，检查 storage/api-docs 目录是否存在且可写

最常被忽略的是注释和路径配置的耦合性：改了控制器位置，不改 config/l5-swagger.php 的 apis，再怎么重试 generate 都是徒劳；而注释里一个 @OA 拼错，整条路由就静默消失——它不会报错，只会不出现。