Content-Type */* generates error when format restriction configured

[Nek-]

Given you use the following configuration:

    formats:
        jsonld:
            mime_types: ['application/ld+json']
        html:
            mime_types: ['text/html']
            # The fact I need to have HTML just to get the documentation is another story...

And you query api platform with the following header:

Content-Type: */*; charset=utf-8

This is the default one in some tools like PhpStorm for example.

Observation

Apiplatform fails with error on "wrong format requested" instead of taking the first format specified in configuration.

Expected behavior

As documented, it should take the first format (here jsonld) as format for the current query.

How to fix

The issue is located inside the class ApiPlatform\Core\EventListener\DeserializeListener.

It's a quick win. It may be tricky finally.

[soyuka]

If you have a fix may you send a patch? Thank you very much for the detailed issue anyway!

[Nek-]

I don't have a patch for that. But I tried. And it looks like there's nothing official with what PHPStorm does. https://stackoverflow.com/a/32059243/2263684

But it also looks like software usually support this kind of notation, and also another kind of notation: image/*. This is documented by Mozilla here https://developer.mozilla.org/fr/docs/Web/HTTP/Basics_of_HTTP/MIME_types like everything's normal. x)

This issue may be a bit more tricky than expected.

Here is the related test:

    public function testAllContentType()
    {
        $result = new \stdClass();
        $eventProphecy = $this->prophesize(GetResponseEvent::class);

        $request = new Request([], [], ['data' => $result, '_api_resource_class' => 'Foo', '_api_collection_operation_name' => 'post'], [], [], [], '{}');
        $request->setMethod(Request::METHOD_PUT);
        $request->headers->set('Content-Type', '*/*; charset=UTF-8');
        $eventProphecy->getRequest()->willReturn($request)->shouldBeCalled();

        $serializerProphecy = $this->prophesize(SerializerInterface::class);
        $context = [AbstractNormalizer::OBJECT_TO_POPULATE => true];
        $serializerProphecy->deserialize('{}', 'Foo', 'json', $context)->willReturn($result)->shouldBeCalled();

        $serializerContextBuilderProphecy = $this->prophesize(SerializerContextBuilderInterface::class);
        $serializerContextBuilderProphecy->createFromRequest(Argument::type(Request::class), false, Argument::type('array'))->willReturn([])->shouldBeCalled();

        $serializerProphecy = $this->prophesize(SerializerInterface::class);
        $serializerProphecy->deserialize()->shouldNotBeCalled();

        $listener = new DeserializeListener(
            $serializerProphecy->reveal(),
            $serializerContextBuilderProphecy->reveal(),
            ['jsonld' => ['application/ld+json'], 'xml' => ['text/xml']]
        );
        $listener->onKernelRequest($eventProphecy->reveal());
    }

A new class FormatResolver may be more appropriate.