Symfony - API Platform - File Upload - symfony

Question

I'm trying to implement a file upload with API PLatform following the Documentation using Vich. But it's not working, precisely, the MediaObject is not hydrated by the file I send on my request.
I followed quite exactly the cookbook provided by API Platform but it doesn't seem that my form handle the request well, because it doesn't pass the constraint validation and I get this answer from the API:
{
"type": "https:\/\/tools.ietf.org\/html\/rfc2616#section-10",
"title": "An error occurred",
"detail": "file: This value should not be null.",
"violations": [
{
"propertyPath": "file",
"message": "This value should not be null."
}
]
}
My request is basic : header is multipart/form-data and I send a single and small file (78Ko):
"file" => image.jpg
When I dump my $request object, the file is in it, but the $form->getData() is not hydrated. Any idea why ?
Here is my MediaObject :
namespace App\Entity;
use ApiPlatform\Core\Annotation\ApiProperty;
use ApiPlatform\Core\Annotation\ApiResource;
use App\Traits\updatedAt;
use DateTimeImmutable;
use Doctrine\ORM\Mapping as ORM;
use Symfony\Component\Validator\Constraints as Assert;
use Vich\UploaderBundle\Entity\File;
use Vich\UploaderBundle\Mapping\Annotation as Vich;
/**
* #ApiResource(iri="http://schema.org/MediaObject", collectionOperations={
* "get",
* "post"={
* "method"="POST",
* "path"="/media_objects",
* "controller"=CreateMediaObjectAction::class,
* "defaults"={"_api_receive"=false},
* },
* })
* #Vich\Uploadable
* #ORM\Entity(repositoryClass="App\Repository\MediaObjectRepository")
* #ORM\HasLifecycleCallbacks()
*/
class MediaObject
{
use updatedAt;
/**
* #ORM\Id()
* #ORM\GeneratedValue()
* #ORM\Column(type="integer")
*/
private $id;
/**
* #var File|null
* #Assert\NotNull()
* #Vich\UploadableField(mapping="media_object", fileNameProperty="contentUrl")
*/
public $file;
/**
* #var string|null
* #ORM\Column(type="string", length=255, nullable=true)
* #ApiProperty(iri="http://schema.org/contentUrl")
*/
private $contentUrl;
public function getId(): ?int
{
return $this->id;
}
public function getFile(): ?string
{
return $this->file;
}
/**
* #param string $file
*
* #return MediaObject
* #throws \Exception
*/
public function setFile(string $file): self
{
$this->file = $file;
if (null !== $file) {
$this->updatedAt = new DateTimeImmutable();
}
return $this;
}
public function getContentUrl(): ?string
{
return $this->contentUrl;
}
public function setContentUrl(?string $contentUrl): self
{
$this->contentUrl = $contentUrl;
return $this;
}
}
Here is my Media ObjectType :
namespace App\Form;
use App\Entity\MediaObject;
use Symfony\Component\Form\AbstractType;
use Symfony\Component\Form\FormBuilderInterface;
use Symfony\Component\OptionsResolver\OptionsResolver;
use Vich\UploaderBundle\Form\Type\VichFileType;
class MediaObjectType extends AbstractType
{
public function buildForm(FormBuilderInterface $builder, array $options)
{
$builder
// Configure each fields you want to be submitted here, like a classic form.
->add('file', VichFileType::class, [
'label' => 'label.file',
'required' => false,
])
;
}
public function configureOptions(OptionsResolver $resolver)
{
$resolver->setDefaults([
'data_class' => MediaObject::class,
'csrf_protection' => false,
]);
}
public function getBlockPrefix()
{
return '';
}
}
And here is my controller :
namespace App\Controller;
use ApiPlatform\Core\Bridge\Symfony\Validator\Exception\ValidationException;
use App\Entity\MediaObject;
use App\Form\MediaObjectType;
use Sensio\Bundle\FrameworkExtraBundle\Configuration\IsGranted;
use Symfony\Bridge\Doctrine\RegistryInterface;
use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
use Symfony\Component\Form\FormFactoryInterface;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\Routing\Annotation\Route;
use Symfony\Component\Validator\Validator\ValidatorInterface;
final class CreateMediaObjectController extends AbstractController
{
private $validator;
private $doctrine;
private $factory;
public function __construct(RegistryInterface $doctrine, FormFactoryInterface $factory, ValidatorInterface $validator)
{
$this->validator = $validator;
$this->doctrine = $doctrine;
$this->factory = $factory;
}
/**
* #param Request $request
* #Route("media_objects", name="media")
*
* #return MediaObject
*/
public function mediaCreation(Request $request): MediaObject
{
$mediaObject = new MediaObject();
$form = $this->factory->create(MediaObjectType::class, $mediaObject);
$form->handleRequest($request);
if ($form->isSubmitted() && $form->isValid()) {
$em = $this->doctrine->getManager();
$em->persist($mediaObject);
$em->flush();
// Prevent the serialization of the file property
$mediaObject->file = null;
return $mediaObject;
}
// This will be handled by API Platform and returns a validation error.
throw new ValidationException($this->validator->validate($mediaObject));
}
}

Answer 1

I am using postman and symfony 4.x for this answer.
API URL: localhost/api/media_objects (localhost => baseURL)
Select form-data => Key should be file and select type File ( If
you hover to right side to input you will see drop down)
Choose file and post.
NOTE: you must have config/packages/vich_uploader.yaml with configurations like
vich_uploader:
db_driver: orm
mappings:
media_object:
uri_prefix: /media
upload_destination: '%kernel.project_dir%/public/media'
namer: Vich\UploaderBundle\Naming\UniqidNamer