Merge pull request #2065 from Nek-/feature/add-support-for-interface-as-resource

Add support for interface as a resource

Author: soyuka

features/main/table_inheritance.feature

@@ -291,3 +291,35 @@ Feature: Table inheritance
       "required": ["hydra:member"]
     }
     """
+
+  Scenario: Get the parent interface collection
+    When I send a "GET" request to "/resource_interfaces"
+    Then the response status code should be 200
+    And the response should be in JSON
+    And the header "Content-Type" should be equal to "application/ld+json; charset=utf-8"
+    And the JSON should be valid according to this schema:
+    """
+    {
+      "type": "object",
+      "properties": {
+        "hydra:member": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "properties": {
+              "@type": {
+                "type": "string",
+                "pattern": "^ResourceInterface$"
+              },
+              "foo": {
+                "type": "string",
+                "required": "true"
+              }
+            }
+          },
+          "minItems": 1
+        }
+      },
+      "required": ["hydra:member"]
+    }
+    """

src/Metadata/Resource/Factory/ExtractorResourceMetadataFactory.php

@@ -48,7 +48,7 @@ public function create(string $resourceClass): ResourceMetadata
             }
         }
 
-        if (!class_exists($resourceClass) || !$resource = $this->extractor->getResources()[$resourceClass] ?? false) {
+        if (!(class_exists($resourceClass) || interface_exists($resourceClass)) || !$resource = $this->extractor->getResources()[$resourceClass] ?? false) {
             return $this->handleNotFound($parentResourceMetadata, $resourceClass);
         }
 

tests/Api/ResourceClassResolverTest.php

@@ -18,6 +18,8 @@
 use ApiPlatform\Core\Exception\InvalidArgumentException;
 use ApiPlatform\Core\Metadata\Resource\Factory\ResourceNameCollectionFactoryInterface;
 use ApiPlatform\Core\Metadata\Resource\ResourceNameCollection;
+use ApiPlatform\Core\Tests\Fixtures\DummyResourceImplementation;
+use ApiPlatform\Core\Tests\Fixtures\DummyResourceInterface;
 use ApiPlatform\Core\Tests\Fixtures\TestBundle\Entity\Dummy;
 use ApiPlatform\Core\Tests\Fixtures\TestBundle\Entity\DummyCar;
 use ApiPlatform\Core\Tests\Fixtures\TestBundle\Entity\DummyTableInheritance;
@@ -168,6 +170,17 @@ public function testGetResourceClassWithChildResource()
 
         $resourceClassResolver = new ResourceClassResolver($resourceNameCollectionFactoryProphecy->reveal());
 
-        $this->assertEquals($resourceClassResolver->getResourceClass($t, DummyTableInheritance::class), DummyTableInheritanceChild::class);
+        $this->assertEquals(DummyTableInheritanceChild::class, $resourceClassResolver->getResourceClass($t, DummyTableInheritance::class));
+    }
+
+    public function testGetResourceClassWithInterfaceResource()
+    {
+        $dummy = new DummyResourceImplementation();
+        $resourceNameCollectionFactoryProphecy = $this->prophesize(ResourceNameCollectionFactoryInterface::class);
+        $resourceNameCollectionFactoryProphecy->create()->willReturn(new ResourceNameCollection([DummyResourceInterface::class]))->shouldBeCalled();
+
+        $resourceClassResolver = new ResourceClassResolver($resourceNameCollectionFactoryProphecy->reveal());
+        $resourceClass = $resourceClassResolver->getResourceClass($dummy, DummyResourceInterface::class, true);
+        $this->assertEquals(DummyResourceImplementation::class, $resourceClass);
     }
 }

tests/Fixtures/DummyResourceImplementation.php

@@ -0,0 +1,22 @@
+<?php
+
+/*
+ * This file is part of the API Platform project.
+ *
+ * (c) Kévin Dunglas <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace ApiPlatform\Core\Tests\Fixtures;
+
+class DummyResourceImplementation implements DummyResourceInterface
+{
+    public function getSomething(): string
+    {
+        return 'What is the answer to the universe?';
+    }
+}

tests/Fixtures/DummyResourceInterface.php

@@ -0,0 +1,19 @@
+<?php
+
+/*
+ * This file is part of the API Platform project.
+ *
+ * (c) Kévin Dunglas <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace ApiPlatform\Core\Tests\Fixtures;
+
+interface DummyResourceInterface
+{
+    public function getSomething(): string;
+}

tests/Fixtures/FileConfigurations/interface_resource.yml

@@ -0,0 +1,2 @@
+resources:
+    'ApiPlatform\Core\Tests\Fixtures\DummyResourceInterface': ~

tests/Fixtures/TestBundle/DataProvider/ResourceInterfaceImplementationDataProvider.php

@@ -0,0 +1,39 @@
+<?php
+
+/*
+ * This file is part of the API Platform project.
+ *
+ * (c) Kévin Dunglas <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace ApiPlatform\Core\Tests\Fixtures\TestBundle\DataProvider;
+
+use ApiPlatform\Core\DataProvider\CollectionDataProviderInterface;
+use ApiPlatform\Core\DataProvider\ItemDataProviderInterface;
+use ApiPlatform\Core\DataProvider\RestrictedDataProviderInterface;
+use ApiPlatform\Core\Tests\Fixtures\TestBundle\OtherResources\ResourceInterface;
+use ApiPlatform\Core\Tests\Fixtures\TestBundle\OtherResources\ResourceInterfaceImplementation;
+
+class ResourceInterfaceImplementationDataProvider implements ItemDataProviderInterface, CollectionDataProviderInterface, RestrictedDataProviderInterface
+{
+    public function supports(string $resourceClass, string $operationName = null, array $context = []): bool
+    {
+        return ResourceInterface::class === $resourceClass;
+    }
+
+    public function getItem(string $resourceClass, $id, string $operationName = null, array $context = [])
+    {
+        return (new ResourceInterfaceImplementation())->setFoo('single item');
+    }
+
+    public function getCollection(string $resourceClass, string $operationName = null)
+    {
+        yield (new ResourceInterfaceImplementation())->setFoo('item1');
+        yield (new ResourceInterfaceImplementation())->setFoo('item2');
+    }
+}

tests/Fixtures/TestBundle/OtherResources/ResourceInterface.php

@@ -0,0 +1,19 @@
+<?php
+
+/*
+ * This file is part of the API Platform project.
+ *
+ * (c) Kévin Dunglas <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace ApiPlatform\Core\Tests\Fixtures\TestBundle\OtherResources;
+
+interface ResourceInterface
+{
+    public function getFoo(): string;
+}

tests/Fixtures/TestBundle/OtherResources/ResourceInterfaceImplementation.php

@@ -0,0 +1,37 @@
+<?php
+
+/*
+ * This file is part of the API Platform project.
+ *
+ * (c) Kévin Dunglas <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace ApiPlatform\Core\Tests\Fixtures\TestBundle\OtherResources;
+
+/**
+ * @author Maxime Veber <[email protected]>
+ */
+class ResourceInterfaceImplementation implements ResourceInterface
+{
+    /**
+     * @var string
+     */
+    private $foo;
+
+    public function setFoo(string $foo)
+    {
+        $this->foo = $foo;
+
+        return $this;
+    }
+
+    public function getFoo(): string
+    {
+        return $this->foo;
+    }
+}

tests/Fixtures/TestBundle/Resources/config/api_resources.yml

@@ -3,7 +3,7 @@ resources:
         shortName: 'fileconfigdummy'
         description: 'Dummy resource'
         itemOperations:
-            custom_operation:  
+            custom_operation:
                 method: 'GET'
                 controller: 'app.config_dummy_resource.action'
         properties: