首页
/ 在Scribe中正确使用递归Schema生成API文档

在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)]

技术原理

  1. 资源类与集合类的区别

    • 资源类(Resource)定义了单个资源的转换逻辑
    • 集合类(Collection)是资源类的集合包装
    • 直接使用集合类会导致Scribe无法解析内部结构
  2. collection参数的作用

    • 当设置为true时,Scribe会自动处理为集合响应
    • 同时仍能保持对单个资源结构的解析能力
  3. 递归解析机制

    • Scribe会深度遍历资源类中定义的所有字段
    • 遇到嵌套资源时会继续解析其结构
    • 最终生成完整的响应Schema

最佳实践

  1. 始终优先使用资源类作为ResponseFromApiResource的第一个参数
  2. 对于集合响应,使用collection参数而非集合类
  3. 确保所有嵌套资源都正确定义了toArray方法
  4. 复杂条件字段(如when)可能需要额外处理以确保文档一致性

总结

通过正确使用ResponseFromApiResource注解及其参数,开发者可以确保Scribe能够完整解析API的响应结构,包括各种嵌套资源。这不仅提高了文档的准确性,也使得API消费者能够更好地理解接口返回的数据结构。

登录后查看全文
热门项目推荐

最新内容推荐

项目优选

收起
docsdocs
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
139
1.91 K
kernelkernel
deepin linux kernel
C
22
6
nop-entropynop-entropy
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
8
0
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
192
273
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
923
551
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
421
392
openGauss-serveropenGauss-server
openGauss kernel ~ openGauss is an open source relational database management system
C++
145
189
金融AI编程实战金融AI编程实战
为非计算机科班出身 (例如财经类高校金融学院) 同学量身定制,新手友好,让学生以亲身实践开源开发的方式,学会使用计算机自动化自己的科研/创新工作。案例以量化投资为主线,涉及 Bash、Python、SQL、BI、AI 等全技术栈,培养面向未来的数智化人才 (如数据工程师、数据分析师、数据科学家、数据决策者、量化投资人)。
Jupyter Notebook
74
64
Cangjie-ExamplesCangjie-Examples
本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
344
1.3 K
easy-eseasy-es
Elasticsearch 国内Top1 elasticsearch搜索引擎框架es ORM框架,索引全自动智能托管,如丝般顺滑,与Mybatis-plus一致的API,屏蔽语言差异,开发者只需要会MySQL语法即可完成对Es的相关操作,零额外学习成本.底层采用RestHighLevelClient,兼具低码,易用,易拓展等特性,支持es独有的高亮,权重,分词,Geo,嵌套,父子类型等功能...
Java
36
8