Laravel资源集合与详情接口关联字段差异化输出方案咨询

以下是几种在Laravel中实现「详情接口返回完整Business字段，集合接口返回精简字段」的可行方案：

方案1：在JobOfferResource中根据请求路由动态选择Business资源 #

直接在JobOfferResource的toArray方法里，通过判断当前请求的路由名称（或路径），决定使用完整/精简的Business资源类。

class JobOfferResource extends JsonResource
{
    public function toArray($request)
    {
        // 假设详情路由名为 job_offer.show，集合路由名为 job_offer.index
        $businessResource = match($request->route()->getName()) {
            'job_offer.show' => new BusinessFullResource($this->business),
            default => new BusinessLiteResource($this->business)
        };

        return [
            'id' => $this->id,
            'title' => $this->title,
            'salary' => $this->salary,
            'business' => $businessResource,
            // 其他职位字段
        ];
    }
}

方案2：给BusinessResource添加状态控制字段 #

在BusinessResource内部添加一个状态标记，通过静态方法或构造参数切换「完整/精简」模式，无需额外创建多个资源类。

class BusinessResource extends JsonResource
{
    protected $isLite = false;

    // 静态方法快速创建精简实例
    public static function lite($resource)
    {
        $instance = new static($resource);
        $instance->isLite = true;
        return $instance;
    }

    public function toArray($request)
    {
        $baseFields = [
            'id' => $this->id,
            'name' => $this->name,
            'logo' => $this->logo,
        ];

        if (!$this->isLite) {
            $baseFields = array_merge($baseFields, [
                'address' => $this->address,
                'description' => $this->description,
                'contact_phone' => $this->contact_phone,
                'established_at' => $this->established_at,
            ]);
        }

        return $baseFields;
    }
}

然后在JobOfferResource中按需调用：

// 详情接口用完整字段
'business' => new BusinessResource($this->business),
// 集合接口用精简字段
'business' => BusinessResource::lite($this->business),

方案3：在JobOfferResource中直接控制Business字段集合 #

如果不想额外维护多个Business资源类，可以直接在JobOfferResource的toArray方法里，根据请求场景拼接Business的字段。

class JobOfferResource extends JsonResource
{
    public function toArray($request)
    {
        $isDetail = $request->route()->getName() === 'job_offer.show';

        return [
            'id' => $this->id,
            'title' => $this->title,
            'salary' => $this->salary,
            'business' => [
                'id' => $this->business->id,
                'name' => $this->business->name,
                'logo' => $this->business->logo,
                // 仅在详情接口返回额外字段
                ...($isDetail ? [
                    'address' => $this->business->address,
                    'description' => $this->business->description,
                    'contact_phone' => $this->business->contact_phone,
                ] : []),
            ],
        ];
    }
}

方案4：创建独立的JobOffer集合资源类 #

专门为集合接口创建JobOfferCollectionResource，与单个资源类分开处理，各自定义对应的Business字段结构，逻辑更清晰。

// 集合资源类：JobOfferCollectionResource.php
class JobOfferCollectionResource extends ResourceCollection
{
    public function toArray($request)
    {
        return $this->collection->map(function ($jobOffer) {
            return [
                'id' => $jobOffer->id,
                'title' => $jobOffer->title,
                'salary' => $jobOffer->salary,
                'business' => [
                    'id' => $jobOffer->business->id,
                    'name' => $jobOffer->business->name,
                    'logo' => $jobOffer->business->logo,
                ],
            ];
        });
    }
}

// 单个资源类：JobOfferResource.php
class JobOfferResource extends JsonResource
{
    public function toArray($request)
    {
        return [
            'id' => $this->id,
            'title' => $this->title,
            'salary' => $this->salary,
            'business' => [
                'id' => $this->business->id,
                'name' => $this->business->name,
                'logo' => $this->business->logo,
                'address' => $this->business->address,
                'description' => $this->business->description,
                'contact_phone' => $this->business->contact_phone,
            ],
        ];
    }
}

控制器中调用：

// 集合接口
public function index()
{
    return new JobOfferCollectionResource(JobOffer::with('business')->get());
}

// 详情接口
public function show($id)
{
    return new JobOfferResource(JobOffer::with('business')->findOrFail($id));
}

方案5：通过查询参数动态切换（灵活扩展） #

默认集合返回精简字段，详情返回完整字段，同时允许前端通过查询参数（如?full_business=1）主动获取完整Business数据，适配更多场景。

class JobOfferResource extends JsonResource
{
    public function toArray($request)
    {
        $showFullBusiness = $request->route()->getName() === 'job_offer.show' 
            || $request->boolean('full_business');

        $businessFields = [
            'id' => $this->business->id,
            'name' => $this->business->name,
        ];

        if ($showFullBusiness) {
            $businessFields += [
                'address' => $this->business->address,
                'description' => $this->business->description,
                'contact' => $this->business->contact,
            ];
        }

        return [
            'id' => $this->id,
            'title' => $this->title,
            'business' => $businessFields,
        ];
    }
}

这样用户访问/api/v1/job_offer?full_business=1时，也能拿到每个职位的完整Business信息。

内容的提问来源于stack exchange，提问作者user3125758