在Scribe中正确使用递归Schema生成API文档
2025-07-05 04:44:04作者:冯梦姬Eddie
问题背景
在使用Scribe生成API文档时,开发者经常会遇到资源转换(Resource)与文档生成不匹配的问题。特别是当API返回结构包含嵌套资源时,如何确保文档能够完整展示这些嵌套结构就成为一个关键问题。
核心问题分析
从案例中我们可以看到,开发者定义了一个资源类(Resource),其中包含了多个字段和嵌套资源:
return [
'id' => $this->id,
'name' => $this->name,
'description' => $this->description,
'stats_ongoing' => $this->stats_ongoing,
'probe_type' => new ProbeTypesResource($this->probeType),
'created_at' => new DateTimeResource($this->created_at),
'updated_at' => new DateTimeResource($this->updated_at),
'rules' => $this->when('api/probes' === $request->route()->getPrefix(), fn() => ProbeRulesResource::collection($this->rules)),
'last_metrics' => ProbeMetricsResource::collection($metrics),
];
但在生成的文档中,这些嵌套资源并没有被正确展示,只显示了基础字段。
解决方案
关键在于正确使用ResponseFromApiResource
注解。开发者最初使用的是:
#[ResponseFromApiResource(ProbesCollection::class, Probes::class)]
这会导致Scribe无法正确识别嵌套的资源结构。正确的做法应该是:
#[ResponseFromApiResource(ProbesResource::class, Probes::class, collection: true)]
技术原理
-
资源类与集合类的区别:
- 资源类(Resource)定义了单个资源的转换逻辑
- 集合类(Collection)是资源类的集合包装
- 直接使用集合类会导致Scribe无法解析内部结构
-
collection参数的作用:
- 当设置为true时,Scribe会自动处理为集合响应
- 同时仍能保持对单个资源结构的解析能力
-
递归解析机制:
- Scribe会深度遍历资源类中定义的所有字段
- 遇到嵌套资源时会继续解析其结构
- 最终生成完整的响应Schema
最佳实践
- 始终优先使用资源类作为ResponseFromApiResource的第一个参数
- 对于集合响应,使用collection参数而非集合类
- 确保所有嵌套资源都正确定义了toArray方法
- 复杂条件字段(如when)可能需要额外处理以确保文档一致性
总结
通过正确使用ResponseFromApiResource注解及其参数,开发者可以确保Scribe能够完整解析API的响应结构,包括各种嵌套资源。这不仅提高了文档的准确性,也使得API消费者能够更好地理解接口返回的数据结构。
登录后查看全文
热门项目推荐
相关项目推荐
HunyuanImage-3.0
HunyuanImage-3.0 统一多模态理解与生成,基于自回归框架,实现文本生成图像,性能媲美或超越领先闭源模型00- DDeepSeek-V3.2-ExpDeepSeek-V3.2-Exp是DeepSeek推出的实验性模型,基于V3.1-Terminus架构,创新引入DeepSeek Sparse Attention稀疏注意力机制,在保持模型输出质量的同时,大幅提升长文本场景下的训练与推理效率。该模型在MMLU-Pro、GPQA-Diamond等多领域公开基准测试中表现与V3.1-Terminus相当,支持HuggingFace、SGLang、vLLM等多种本地运行方式,开源内核设计便于研究,采用MIT许可证。【此简介由AI生成】Python00
GitCode-文心大模型-智源研究院AI应用开发大赛
GitCode&文心大模型&智源研究院强强联合,发起的AI应用开发大赛;总奖池8W,单人最高可得价值3W奖励。快来参加吧~0370Hunyuan3D-Part
腾讯混元3D-Part00ops-transformer
本项目是CANN提供的transformer类大模型算子库,实现网络在NPU上加速计算。C++0102AI内容魔方
AI内容专区,汇集全球AI开源项目,集结模块、可组合的内容,致力于分享、交流。02Spark-Chemistry-X1-13B
科大讯飞星火化学-X1-13B (iFLYTEK Spark Chemistry-X1-13B) 是一款专为化学领域优化的大语言模型。它由星火-X1 (Spark-X1) 基础模型微调而来,在化学知识问答、分子性质预测、化学名称转换和科学推理方面展现出强大的能力,同时保持了强大的通用语言理解与生成能力。Python00GOT-OCR-2.0-hf
阶跃星辰StepFun推出的GOT-OCR-2.0-hf是一款强大的多语言OCR开源模型,支持从普通文档到复杂场景的文字识别。它能精准处理表格、图表、数学公式、几何图形甚至乐谱等特殊内容,输出结果可通过第三方工具渲染成多种格式。模型支持1024×1024高分辨率输入,具备多页批量处理、动态分块识别和交互式区域选择等创新功能,用户可通过坐标或颜色指定识别区域。基于Apache 2.0协议开源,提供Hugging Face演示和完整代码,适用于学术研究到工业应用的广泛场景,为OCR领域带来突破性解决方案。00- HHowToCook程序员在家做饭方法指南。Programmer's guide about how to cook at home (Chinese only).Dockerfile09
- PpathwayPathway is an open framework for high-throughput and low-latency real-time data processing.Python00
项目优选
收起

deepin linux kernel
C
22
6

OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
205
2.19 K

暂无简介
Dart
514
115

Ascend Extension for PyTorch
Python
62
95

本项目是CANN提供的数学类基础计算算子库,实现网络在NPU上加速计算。
C++
550
86

React Native鸿蒙化仓库
C++
208
285

Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
9
1

🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
976
576

旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
1.02 K
399

openGauss kernel ~ openGauss is an open source relational database management system
C++
146
193