如何使用Laravel JSON:API创建并同步BelongsToMany多对多关系？

我已经熟悉Laravel多对多（Many To Many）关系的创建，示例中多个resources共享多个activities，模型层已实现关系：

// Activity.php
public function resources(): BelongsToMany
{
    return $this->belongsToMany(Resource::class)->withTimestamps();
}

// Resource.php
public function activities(): BelongsToMany
{
    return $this->belongsToMany(Activity::class)->withTimestamps()
            ->using(new class extends Pivot {
                use HasUuids;
            });
}

原本使用sync方法同步关系：

$activityIds = ['9a4cf36f-7683-4656-9653-9a01e1edbca1', '9a5225f0-31f6-40be-8863-6e8de61ef29f'];
$resource->activities()->sync($activityIds);

现在尝试用Laravel JSON:API包实现相同逻辑，定义的Schema如下：

ActivitySchema

return [
    ...
    BelongsToMany::make('resources')->readOnly(),
    ...
];

ResourceSchema

return [
    ...
    ArrayList::make('activities'),
    
    ...

    BelongsToMany::make('activities')->readOnly(),
    ...
];

用Postman创建/更新资源时，请求体如下：

"attributes": {
    "activities": ["9a4cf36f-7683-4656-9653-9a01e1edbca1", "9a5225f0-31f6-40be-8863-6e8de61ef29f"]
    ...
}

创建新资源时触发错误：

"detail": "The field activities is not a supported attribute."

确认Schema中已存在该字段，怀疑是关系配置问题，尝试自定义Pivot模型也无效，不清楚是否需要自定义控制器，也找不到同步关系的官方说明，请问如何通过JSON:API包创建/同步这个多对多关系？

1. 清理Schema中的重复定义 #

你在ResourceSchema里同时加了ArrayList::make('activities')和BelongsToMany::make('activities')，这会造成字段冲突。JSON:API里多对多关系属于关系字段，不是普通属性，直接删掉ArrayList::make('activities')这一行就行。

2. 解除关系的只读限制 #

当前BelongsToMany::make('activities')->readOnly()把关系设成了只读，自然没法通过创建/更新请求修改，去掉readOnly()：

// ResourceSchema
return [
    ...
    BelongsToMany::make('activities'),
    ...
];

3. 按JSON:API规范调整请求结构 #

JSON:API要求关系字段必须放在relationships节点下，不能塞在attributes里，正确的请求体应该是这样：

{
    "data": {
        "type": "resources",
        "attributes": {
            // 这里放资源的其他属性，比如name、description之类的
        },
        "relationships": {
            "activities": {
                "data": [
                    {"type": "activities", "id": "9a4cf36f-7683-4656-9653-9a01e1edbca1"},
                    {"type": "activities", "id": "9a5225f0-31f6-40be-8863-6e8de61ef29f"}
                ]
            }
        }
    }
}

4. 自定义控制器（按需使用） #

如果默认JSON:API控制器处理不了带UUID的Pivot逻辑，就自己写ResourceController，重写store或update方法手动调用sync：

use Illuminate\Http\Request;
use LaravelJsonApi\Core\Controllers\JsonApiController;

class ResourceController extends JsonApiController
{
    public function store(Request $request)
    {
        $resource = parent::store($request);
        
        // 手动同步活动关系
        $activityIds = collect($request->input('data.relationships.activities.data'))->pluck('id');
        $resource->activities()->sync($activityIds);
        
        return $resource;
    }
}

5. 确认Pivot模型配置 #

如果用的是匿名Pivot类，得确保它正确继承Pivot并启用HasUuids，同时多对多关联的表名要符合Laravel约定（默认是activity_resource，按字母顺序拼接），或者在关联方法里明确指定表名：

// Resource.php
public function activities(): BelongsToMany
{
    return $this->belongsToMany(Activity::class, 'activity_resource')
            ->withTimestamps()
            ->using(new class extends Pivot {
                use HasUuids;
            });
}

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