讲师中心 微信公众号

工具推荐

视频效率加速
AniShort
AniShort

AI短剧协同制作平台

updream

一键生成高质量推广成片

Laper
Laper

剧本策划到成片协作

Seko
Seko

AI短剧一键生成成片

Laravel文档完善神器推荐:为什么Scribe比传统Swagger更适合Laravel?【汇总】

小辰大大_2100

小辰大大_2100

发布时间:2026-06-16 23:08:25

|

376人浏览过

|

来源于php中文网

原创

Scribe比传统Swagger更适合Laravel,核心在于它不是“套用OpenAPI标准”,而是“理解Laravel本身”——自动读取路由定义、FormRequest验证规则、Resource响应结构和中间件逻辑,生成的文档天然贴合框架行为,不靠手写注解堆砌,也不因PHP 8.1+属性语法或apiResource隐式绑定而失效。

laravel文档完善神器推荐:为什么scribe比传统swagger更适合laravel?【汇总】

Scribe比传统Swagger更适合Laravel,核心在于它不是“套用OpenAPI标准”,而是“理解Laravel本身”——自动读取路由定义、FormRequest验证规则、Resource响应结构和中间件逻辑,生成的文档天然贴合框架行为,不靠手写注解堆砌,也不因PHP 8.1+属性语法或apiResource隐式绑定而失效。

自动扫描Laravel原生结构,不依赖人工注释

Scribe直接解析控制器方法签名、绑定的FormRequest类、返回类型提示(如UserResource::make())、甚至中间件跳过逻辑。它不需要你反复在代码里写@OA\Get或@bodyParam,更不会因PHP 8.1+的#[Validate]属性而漏掉验证字段。Swagger-php则必须手动补全所有@OA注解,稍有遗漏,参数就消失或类型错乱。

  • Route::apiResource('posts', PostController::class) → 自动识别全部7个REST动作及对应请求/响应
  • store(Request $request)中注入StorePostRequest → 自动提取全部required/string/email等规则并转为文档参数
  • return PostResource::collection($posts) → 推断出分页结构、data数组、每个post字段类型与示例

生成即用型交互文档,无需额外部署管道

Scribe默认输出静态HTML页面(public/docs/index.html),开箱支持“Try it out”功能,自动携带Bearer Token、填充表单、显示真实响应。它导出的OpenAPI 3.0 JSON可直供Postman导入或API网关接入,不需要像Swagger-ui那样单独配Nginx路由、维护swagger.json路径或调试CORS问题。

Laravel Cloud
Laravel Cloud

Laravel Cloud(cloud.laravel.com)。此技能用于处理所有 Laravel Cloud 请求,包括搜索和读取数据。只要任务涉及 Laravel Cloud,即使用此技能。

下载
  • 执行php artisan scribe:generate后,访问/docs即可在线调试接口
  • Token认证说明自动出现在每个需要鉴权的接口页,无需重复写@authenticated
  • 错误响应(如422校验失败)也能从FormRequest的messages()中提取示例,不是空泛的“Bad Request”

无缝嵌入开发流程,避免文档与代码脱节

Scribe能自然融入CI/CD:在GitHub Actions中监听main分支合并,自动运行scribe:generate并推送至GitHub Pages或内部Nginx目录。它不强制要求PR中提交swagger.yaml变更,也不因某次忘记更新注释导致线上文档失真——文档随代码一起构建,而不是靠人肉同步。

  • MR/PR阶段只需检查控制器注释是否清晰(如@group、@response),而非整套OpenAPI语法
  • 配置文件config/scribe.php可设置仅扫描app/Http/Controllers/Api目录,排除测试或管理接口
  • 支持中文字段名、多语言响应示例,不用额外改locale或hack模板

轻量稳定,适配Laravel 10+主流生态

相比已停更的Swagger-Lume,或需深度定制的swagger-php + swagger-ui组合,Scribe由Laravel社区活跃维护(knuckleswtf组织),对Laravel 10+、PHP 8.2、Livewire、Inertia等现代栈兼容良好。它不侵入路由注册、不替换服务容器绑定,安装即用,故障时排查路径清晰——报错通常指向具体控制器或Request类,而非抽象的注解解析器。

  • 安装仅需一条命令:composer require --dev knuckleswtf/scribe
  • 发布配置:php artisan scribe:install,无须修改autoload或手动注册服务提供者
  • 不强制使用@response标签——若未提供,Scribe会尝试从实际API响应中抓取结构(需开启"laravel_api_tester"配置)

热门AI工具

更多
花生AI
花生AI Hot

一款AI视频创作工具,主要用于B站推出的AI视频创作工具,适合需要提升相关任务效率的用户。

Flowith
Flowith Hot

Flowith是一款基于画布和智能体工作流的 AI 协作工作空间。

PixTV
PixTV Hot

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

超级简历WonderCV

一款AI办公效率工具,主要用于免费求职简历模版下载制作,应届生职场人必备简历制作神器,适合需要提升相关任务效率的用户。

DeepSeek

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

豆包大模型

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

Laper
Laper Hot

Laper是专为编剧、导演和制片人推出的 AI 原生剧本创作工具。

WorkBuddy

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

讯飞绘文

讯飞绘文是一款由科大讯飞推出的一站式 AIGC 内容运营平台。

相关专题

更多
php文件怎么打开
php文件怎么打开

打开php文件步骤:1、选择文本编辑器;2、在选择的文本编辑器中,创建一个新的文件,并将其保存为.php文件;3、在创建的PHP文件中,编写PHP代码;4、要在本地计算机上运行PHP文件,需要设置一个服务器环境;5、安装服务器环境后,需要将PHP文件放入服务器目录中;6、一旦将PHP文件放入服务器目录中,就可以通过浏览器来运行它。

12804

2023.09.01

php怎么取出数组的前几个元素
php怎么取出数组的前几个元素

取出php数组的前几个元素的方法有使用array_slice()函数、使用array_splice()函数、使用循环遍历、使用array_slice()函数和array_values()函数等。本专题为大家提供php数组相关的文章、下载、课程内容,供大家免费下载体验。

7341

2023.10.11

php反序列化失败怎么办
php反序列化失败怎么办

php反序列化失败的解决办法检查序列化数据。检查类定义、检查错误日志、更新PHP版本和应用安全措施等。本专题为大家提供php反序列化相关的文章、下载、课程内容,供大家免费下载体验。

2255

2023.10.11

php怎么连接mssql数据库
php怎么连接mssql数据库

连接方法:1、通过mssql_系列函数;2、通过sqlsrv_系列函数;3、通过odbc方式连接;4、通过PDO方式;5、通过COM方式连接。想了解php怎么连接mssql数据库的详细内容,可以访问下面的文章。

4628

2023.10.23

php连接mssql数据库的方法
php连接mssql数据库的方法

php连接mssql数据库的方法有使用PHP的MSSQL扩展、使用PDO等。想了解更多php连接mssql数据库相关内容,可以阅读本专题下面的文章。

5354

2023.10.23

html怎么上传
html怎么上传

html通过使用HTML表单、JavaScript和PHP上传。更多关于html的问题详细请看本专题下面的文章。php中文网欢迎大家前来学习。

4211

2023.11.03

PHP出现乱码怎么解决
PHP出现乱码怎么解决

PHP出现乱码可以通过修改PHP文件头部的字符编码设置、检查PHP文件的编码格式、检查数据库连接设置和检查HTML页面的字符编码设置来解决。更多关于php乱码的问题详情请看本专题下面的文章。php中文网欢迎大家前来学习。

6117

2023.11.09

php文件怎么在手机上打开
php文件怎么在手机上打开

php文件在手机上打开需要在手机上搭建一个能够运行php的服务器环境,并将php文件上传到服务器上。再在手机上的浏览器中输入服务器的IP地址或域名,加上php文件的路径,即可打开php文件并查看其内容。更多关于php相关问题,详情请看本专题下面的文章。php中文网欢迎大家前来学习。

4802

2023.11.13

Go-Zero API开发使用教程
Go-Zero API开发使用教程

本专题聚焦Go-Zero的API开发,拆解.api描述文件的语法结构、路由与分组定义、参数绑定与校验规则,说明统一响应体、JWT鉴权、跨域与接口文档生成的落地方式,并给出网关聚合与接口测试的实践建议。

20

2026.11.12

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
如何安装 Composer
如何安装 Composer

共1课时 | 226人学习

Composer手册
Composer手册

共0课时 | 0人学习

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

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