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

问题背景

在使用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消费者能够更好地理解接口返回的数据结构。