讲师中心 微信公众号
AI工具推荐 视频效率加速

接口文档:Laravel框架快速部署Swagger

夏辰同学_9135

夏辰同学_9135

发布时间:2026-08-07 20:11:11

|

664人浏览过

|

来源于php中文网

原创

要在Laravel项目中快速部署可交互的Swagger API文档界面,必须安装适配版本的l5-swagger包(如Laravel 12/13用^9.0),发布配置与视图资源,配置扫描路径和API元信息,启用自动生成功能,并在控制器方法上添加标准@OA注解,最后执行生成命令并访问/api/documentation验证。

接口文档:laravel框架快速部署swagger

要在Laravel项目中快速部署可交互的Swagger API文档界面,必须绕过手动维护静态文档的低效方式,直接利用OpenAPI规范驱动的自动化生成能力,确保每次代码更新后文档即时同步。

安装L5-Swagger并发布基础资源

在项目根目录执行命令安装适配当前Laravel版本的包:composer require "darkaonline/l5-swagger:^9.0"。Laravel 12/13需严格匹配^9.0,用^8.0会导致config_path()调用失败。

运行命令发布配置文件:php artisan vendor:publish --provider "L5Swagger\L5SwaggerServiceProvider" --tag=config。这会生成config/l5-swagger.php,是后续所有路径与行为控制的源头。

再执行命令发布UI视图与静态资源:php artisan vendor:publish --provider "L5Swagger\L5SwaggerServiceProvider" --tag=views。此步将Swagger UI所需CSS、JS注入resources/views/vendor/l5-swagger,缺则页面空白。

配置扫描路径与基础元信息

打开config/l5-swagger.php,定位到'default' => [...]配置组。

修改info字段填入项目真实信息:'title' => '订单中心API', 'version' => 'v2.1', 'description' => '含支付回调、退款核验等核心接口'。标题和版本号会直接显示在UI顶部,写错会导致前端误判接口兼容性。

检查paths下的apis数组,确保包含实际控制器路径:["app/Http/Controllers/Api/**/*.php", "app/Http/Controllers/V1/**/*.php"]。若控制器分散在Modules/User/Http/Controllers这类非标准路径,【必须显式添加对应glob模式】,否则php artisan l5-swagger:generate完全不扫描这些文件。

Laravel Creem Agent
Laravel Creem Agent

Creem 支付商店助理 — 查询订阅、客户、交易、产品,执行心跳检查,管理本地 Laravel支付商店。

下载

将generate_always设为true(开发环境),这样每次访问文档页都会自动重解析注解。生产环境务必改回false并配合CI流程手动触发生成,避免每次请求都执行耗时扫描。

编写首个OpenAPI注解并验证生成

在任意控制器方法上方添加最简可用注解:

/**
* @OA\Get(
* path="/api/health",
* summary="服务健康检查",
* @OA\Response(response="200", description="返回ok")
*/

注意:注解必须以@OA\开头(不是@SWG\),且紧贴方法声明,中间不能有空行——空行会导致L5-Swagger跳过整段解析。

执行生成命令:php artisan l5-swagger:generate。成功时终端输出Docs generated successfully,并在storage/api-docs下生成api-docs.json。

启动本地服务:php artisan serve,访问http://127.0.0.1:8000/api/documentation。页面加载后左侧应出现GET /api/health条目,点击“Try it out”→“Execute”能收到{"message":"ok"}响应。

热门AI工具

更多
SkildArt
SkildArt Hot

SkildArt是一款AI文本写作工具,一站式 AI 视觉创作平台。

讯飞智作

讯飞智作是一款AI视频创作工具,AI文本配音工具,数字人课程、营销视频制作。

音述AI
音述AI Hot

一款AI音频处理工具,主要用于音述AI是一个以“用声音述说故事”为核心的 AI 音乐创作与声音分享社区,适合需要提升相关任务效率的用户。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

PixTV
PixTV Hot

PixTV是一款面向AIGC内容创作的AI视频生成工具。

蛙蛙写作

一款AI论文写作工具,主要用于超级AI智能写作助手,适合需要提升相关任务效率的用户。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

立刻MV
立刻MV Hot

立刻MV是一款AI文本写作工具,AI 音乐视频(MV)创作工具。

相关专题

更多
laravel组件介绍
laravel组件介绍

laravel 提供了丰富的组件,包括身份验证、模板引擎、缓存、命令行工具、数据库交互、对象关系映射器、事件处理、文件操作、电子邮件发送、队列管理和数据验证。想了解更多laravel的相关内容,可以阅读本专题下面的文章。

837

2024.04.09

laravel中间件介绍
laravel中间件介绍

laravel 中间件分为五种类型:全局、路由、组、终止和自定。想了解更多laravel中间件的相关内容,可以阅读本专题下面的文章。

815

2024.04.09

laravel使用的设计模式有哪些
laravel使用的设计模式有哪些

laravel使用的设计模式有:1、单例模式;2、工厂方法模式;3、建造者模式;4、适配器模式;5、装饰器模式;6、策略模式;7、观察者模式。想了解更多laravel的相关内容,可以阅读本专题下面的文章。

2468

2024.04.09

thinkphp和laravel哪个简单
thinkphp和laravel哪个简单

对于初学者来说,laravel 的入门门槛较低,更易上手,原因包括:1. 更简单的安装和配置;2. 丰富的文档和社区支持;3. 简洁易懂的语法和 api;4. 平缓的学习曲线。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

3701

2024.04.10

laravel入门教程
laravel入门教程

本专题整合了laravel入门教程,想了解更多详细内容,请阅读专题下面的文章。

5250

2025.08.05

laravel实战教程
laravel实战教程

本专题整合了laravel实战教程,阅读专题下面的文章了解更多详细内容。

3516

2025.08.05

laravel面试题
laravel面试题

本专题整合了laravel面试题相关内容,阅读专题下面的文章了解更多详细内容。

6649

2025.08.05

PHP高性能API设计与Laravel服务架构实践
PHP高性能API设计与Laravel服务架构实践

本专题围绕 PHP 在现代 Web 后端开发中的高性能实践展开,重点讲解基于 Laravel 框架构建可扩展 API 服务的核心方法。内容涵盖路由与中间件机制、服务容器与依赖注入、接口版本管理、缓存策略设计以及队列异步处理方案。同时结合高并发场景,深入分析性能瓶颈定位与优化思路,帮助开发者构建稳定、高效、易维护的 PHP 后端服务体系。

1376

2026.03.04

LLVM自定义Pass怎么写
LLVM自定义Pass怎么写

本专题聚焦LLVM自定义Pass开发,整理Pass类结构、run()方法、PreservedAnalyses、CMake构建、插件注册、-load-pass-plugin加载和测试用例编写流程。

80

2026.09.30

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn