API Platform中如何让DTO字段仅在POST而非PUT中暴露？

有两种常用方法可以实现你的需求，确保PUT请求的OpenAPI文档中不显示email字段：

方法1：为PUT请求创建独立的输入DTO #

这种方式直观清晰，针对不同请求类型使用专属DTO，避免字段混淆：

1. 创建CustomerUpdateInput类，移除不需要的email字段：

// src/DTO/CustomerUpdateInput.php
class CustomerUpdateInput
{
    public string $fiscalId;
    public string $businessName;
}

2. 修改资源配置YAML，在PUT操作中指定专属的input：

App\Entity\Customer:
  attributes:
    input: 'App\DTO\CustomerInput'
    output: 'App\DTO\CustomerOutput'
  collectionOperations:
    get:
      path: /customer
    post:
      path: /customer
  itemOperations:
    get:
      path: /customer/{fiscalId}
    put:
      path: /customer/{fiscalId}
      input: 'App\DTO\CustomerUpdateInput' # 为PUT指定专属输入DTO

完成后，PUT请求的OpenAPI文档会基于CustomerUpdateInput生成，自然不会包含email字段。

方法2：使用序列化组控制字段显示 #

如果不想创建多个DTO，可以通过Api Platform的序列化组功能，在同一个DTO里控制不同请求下的字段可见性：

1. 修改CustomerInput，为字段添加序列化组注解：

// src/DTO/CustomerInput.php
use ApiPlatform\Metadata\ApiProperty;

class CustomerInput
{
    public string $fiscalId;

    #[ApiProperty(groups: ['post'])]
    public string $email;

    public string $businessName;
}

2. 在资源配置中为POST和PUT操作指定不同的序列化组：

App\Entity\Customer:
  attributes:
    input: 'App\DTO\CustomerInput'
    output: 'App\DTO\CustomerOutput'
  collectionOperations:
    get:
      path: /customer
    post:
      path: /customer
      denormalization_context:
        groups: ['post'] # POST请求启用post组，包含email字段
  itemOperations:
    get:
      path: /customer/{fiscalId}
    put:
      path: /customer/{fiscalId}
      # PUT不指定post组，email字段会被自动排除

这样PUT请求的OpenAPI文档会忽略带有post组的email字段，同时POST请求正常显示该字段。

两种方法都能满足需求：第一种适合字段差异较大的场景，逻辑更清晰；第二种更简洁，适合字段差异小的情况。

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