[RFC] Authorize interface as resource

[Nek-]

Problem

In my application I use the KnpDictionaryBundle. This bundle provide an interface to implement dictionaries but no resource class (but provide a dictionary registry), which is incompatible with api platform ATM.

I think api platform should authorize interface as a resource because I'm pretty sure it's not the only software to act like this.

Solution

Modify the ExtractorResourceMetadataFactory to support interfaces:

// before
if (!class_exists($resourceClass) || !$resource = $this->extractor->getResources()[$resourceClass] ?? false)

// After
if (!(class_exists($resourceClass) || interface_exists($resourceClass)) || !$resource = $this->extractor->getResources()[$resourceClass] ?? false)

What do you think?

[soyuka]

They may be other interferences (like

core/src/Api/ResourceClassResolver.php

Line 40 in 9c9f2fd

public function getResourceClass($value, string $resourceClass = null, bool $strict = false): string

)

Though I don't really get how an interface could be used as a resource without overriding some parts of the call chain. Could you elaborate?

[Nek-]

If you want to use an interface as a resource you're probably going to also add a normalizer (which is not bad, right? :) ). Did you check out the dictionary bundle? I'm talking about the Dictionary interface (for my case).

According to my tests, there is no other interference. (I'll push my tests a little bit more today)

Please notice that abstract classes are supported (which make not supporting interface weirder).

[soyuka]

I don't see why we should not support them ofc. But yes you're right it doesn't make sense alone!

[Nek-]

There's indeed something to change. The following line is wrong:

core/src/Api/ResourceClassResolver.php

Line 73 in 0ed9a02

if ($type === $resourceClass) {

// This is more accurate
if ($type === $resourceClass || is_subclass_of($type, $resourceClass)) 

[soyuka]

😄 feel free to patch this on master!