Symfony 和 API 平台 - 通过 slug 或 userToken 或任何其他不同于 ID 的字段检索数据

Question

What I'm trying to do is:

• send a request from my frontend to API custom url to activate user account (/account/activate/someTokenValue)
• retrieve user form database by confirmationToken value
• activate user account and save it to database
• return activation information (or some errors if eg token is invalid)

So I've defined:

* @ApiResource(itemOperations={
 *     "get",
 *     "activate_account"={
 *         "method"="get",
 *         "path"="/account/activate/{confirmationToken}",
 *         "controller"=UserActivate::class
 *     }
 * })
 */

In my User entity class there is UserActivate controller and UserActivateHandler that is invoked by UserActivate controller. I've set ApiProperty identifier for ID to false and for confirmationToken to true .

   /**
     * @ORM\Id()
     * @ORM\GeneratedValue()
     * @ORM\Column(type="integer")
     * @ApiProperty(identifier=false)
     *
     */
    private $id;

    /**
      * 
      * @ORM\Column(type="string", nullable=true)
      * @ApiProperty(identifier=true)
      */
    protected $confirmationToken;

However API Platform still requires an ID and it doesn't seem to see confirmationToken parameter.

Basically my question is, how I can retrieve an object by, in this case, confirmationToken ?

Answer 1

I had the same problem, getting an entity by a different property than the one indicated as the identifier; you did well with the property annotations:

@ApiProperty(identifier=false) 
@ApiProperty(identifier=true)

but at the same time you have to mantain the {id} in your path, so change

"path"="/account/activate/{confirmationToken}",

to

"path"="/account/activate/{id}"