在Laravel Scribe中处理路由模型绑定的FormRequest验证问题

问题背景

在使用Laravel Scribe生成API文档时，开发人员经常会遇到一个典型问题：当FormRequest验证规则中使用了路由模型绑定的参数时，Scribe在解析过程中会抛出类型错误。这是因为Scribe在解析验证规则时，会直接实例化FormRequest类并调用rules方法，而此时路由参数尚未绑定，导致模型对象为null。

问题示例

考虑以下典型场景：我们有一个更新组织信息的API端点，使用FormRequest进行验证，并在验证规则中使用了Rule::unique()方法来确保邮箱唯一性，同时忽略当前组织记录。

class UpdateOrganisationRequest extends FormRequest
{
    public function rules(): array
    {
        return [
            'name' => ['string', 'required', 'max:255'],
            'email' => [
                'bail',
                'string',
                'required',
                'max:255',
                'email',
                Rule::unique(Organisation::class, 'email')
                    ->ignore($this->organisationModel()->id),
            ],
        ];
    }

    private function organisationModel(): Organisation
    {
        /** @var Organisation $organisation */
        $organisation = $this->route('organisation');
        return $organisation;
    }
}

当Scribe尝试解析这个FormRequest时，由于没有实际的路由绑定，$this->route('organisation')会返回null，导致类型错误。

解决方案

方案一：自定义FormRequest实例化方式

Scribe提供了钩子机制，允许我们自定义FormRequest的实例化过程。我们可以创建一个自定义实例化器，在实例化特定FormRequest类时提供默认的路由参数。

// 在Scribe配置中添加
'instantiateFormRequestUsing' => function (string $className, Route $route, array $routeDetails) {
    $request = new $className;
    
    if ($className === UpdateOrganisationRequest::class) {
        $request->merge([
            'organisation' => Organisation::factory()->make(),
        ]);
    }
    
    return $request;
},

这种方法适用于少量特殊FormRequest类的情况。对于大型项目，可以考虑创建一个基础FormRequest类，在其中实现通用的模型绑定处理逻辑。

方案二：使用静态数据策略（Scribe v5+）

在Scribe v5及以上版本中，我们可以配置策略来忽略某些端点的自动解析，并手动提供参数信息。

'bodyParameters' => [
    ...configureStrategy(
        Defaults::BODY_PARAMETERS_STRATEGIES,
        Strategies\BodyParameters\GetFromFormRequest::wrapWithSettings(except: ['organisations.update'])
    ),
    Strategies\StaticData::withSettings(
        only: ['organisations.update'],
        data: [
            'name' => [
                'type' => 'string',
                'required' => true,
                'description' => '组织名称',
                'example' => 'Acme Inc.'
            ],
            'email' => [
                'type' => 'string',
                'required' => true,
                'description' => '组织邮箱',
                'example' => '[e-mail]'
            ]
        ]
    ),
]

方案三：条件性返回验证规则

我们还可以修改FormRequest类，使其在Scribe解析时返回简化的验证规则：

class UpdateOrganisationRequest extends FormRequest
{
    public function rules(): array
    {
        $rules = [
            'name' => ['string', 'required', 'max:255'],
            'email' => ['bail', 'string', 'required', 'max:255', 'email'],
        ];
        
        if ($this->organisationModel()) {
            $rules['email'][] = Rule::unique(Organisation::class, 'email')
                ->ignore($this->organisationModel()->id);
        }
        
        return $rules;
    }
}

最佳实践建议

1. 分离文档生成和实际验证逻辑：考虑将用于文档生成的简化规则与实际应用验证规则分开处理。

2. 使用工厂模式：为常见模型绑定场景创建工厂类，统一处理文档生成时的模型实例化。

3. 版本控制：随着Scribe v5的发布，建议优先考虑使用其提供的新策略系统来处理这类问题。

4. 文档测试：在CI/CD流程中加入文档生成的测试步骤，确保文档生成不会因验证规则问题而失败。

总结

处理Laravel Scribe中路由模型绑定与FormRequest验证的冲突需要根据项目具体情况选择合适的方法。对于小型项目，简单的条件性规则返回可能就足够了；而对于大型复杂项目，则可能需要更系统化的解决方案，如自定义实例化逻辑或使用Scribe v5的策略系统。无论选择哪种方法，关键是要确保文档生成过程不会影响实际应用的验证逻辑，同时生成的文档又能准确反映API的行为。