Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 14 additions & 2 deletions src/Symfony/Routing/ApiLoader.php
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
namespace ApiPlatform\Symfony\Routing;

use ApiPlatform\Metadata\Exception\RuntimeException;
use ApiPlatform\Metadata\NotExposed;
use ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface;
use ApiPlatform\Metadata\Resource\Factory\ResourceNameCollectionFactoryInterface;
use ApiPlatform\OpenApi\Attributes\Webhook;
Expand All @@ -34,6 +35,8 @@
final class ApiLoader extends Loader
{
public const DEFAULT_ACTION_PATTERN = 'api_platform.action.';
public const TYPE = 'api_platform';
public const TYPE_IRIS = 'api_platform_iris';

private readonly PhpFileLoader $fileLoader;

Expand All @@ -48,15 +51,24 @@ public function __construct(KernelInterface $kernel, private readonly ResourceNa
*/
public function load(mixed $data, ?string $type = null): RouteCollection
{
$notExposedOnly = self::TYPE_IRIS === $type;

$routeCollection = new RouteCollection();
foreach ($this->resourceClassDirectories as $directory) {
$routeCollection->addResource(new DirectoryResource($directory, '/\.php$/'));
}

$this->loadExternalFiles($routeCollection);
if (!$notExposedOnly) {
$this->loadExternalFiles($routeCollection);
}

foreach ($this->resourceNameCollectionFactory->create() as $resourceClass) {
foreach ($this->resourceMetadataFactory->create($resourceClass) as $resourceMetadata) {
foreach ($resourceMetadata->getOperations() as $operationName => $operation) {
if ($notExposedOnly && !$operation instanceof NotExposed) {
continue;
}

if ($operation->getOpenapi() instanceof Webhook) {
continue;
}
Expand Down Expand Up @@ -119,7 +131,7 @@ public function load(mixed $data, ?string $type = null): RouteCollection
*/
public function supports(mixed $resource, ?string $type = null): bool
{
return 'api_platform' === $type;
return self::TYPE === $type || self::TYPE_IRIS === $type;
}

/**
Expand Down
21 changes: 21 additions & 0 deletions tests/Symfony/Routing/ApiLoaderTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@
use ApiPlatform\Metadata\Get;
use ApiPlatform\Metadata\GetCollection;
use ApiPlatform\Metadata\Link;
use ApiPlatform\Metadata\NotExposed;
use ApiPlatform\Metadata\Operations;
use ApiPlatform\Metadata\Property\Factory\PropertyMetadataFactoryInterface;
use ApiPlatform\Metadata\Property\Factory\PropertyNameCollectionFactoryInterface;
Expand Down Expand Up @@ -257,6 +258,25 @@ public function testApiLoaderWithPrefix(): void
);
}

public function testApiLoaderIrisTypeOnlyEmitsNotExposedRoutes(): void
{
$resourceCollection = new ResourceMetadataCollection(Dummy::class, [
(new ApiResource())->withShortName('dummy')->withOperations(new Operations([
'api_dummies_get_item' => (new Get())->withUriTemplate('/dummies/{id}{._format}')->withController('api_platform.action.get_item'),
'api_dummies_get_collection' => (new GetCollection())->withUriTemplate('/dummies{._format}'),
'api_dummies_not_exposed_item' => (new NotExposed())->withUriTemplate('/dummies/{id}{._format}'),
])),
]);

$routeCollection = $this->getApiLoaderWithResourceMetadataCollection($resourceCollection)->load(null, ApiLoader::TYPE_IRIS);

$this->assertNull($routeCollection->get('api_dummies_get_item'));
$this->assertNull($routeCollection->get('api_dummies_get_collection'));
$this->assertNotNull($routeCollection->get('api_dummies_not_exposed_item'));
$this->assertNull($routeCollection->get('api_jsonld_context'));
$this->assertNull($routeCollection->get('api_entrypoint'));
}

public function testApiLoaderWithUndefinedControllerService(): void
{
$this->expectExceptionObject(new \RuntimeException('Operation "api_dummies_my_undefined_controller_method_item" is defining an unknown service as controller "Foo\\Bar\\MyUndefinedController". Make sure it is properly registered in the dependency injection container.'));
Expand Down Expand Up @@ -284,6 +304,7 @@ private function getApiLoaderWithResourceMetadataCollection(ResourceMetadataColl
'api_platform.action.get_item',
'api_platform.action.put_item',
'api_platform.action.delete_item',
'api_platform.action.not_exposed',
'Foo\\Bar\\MyController',
];
$containerProphecy = $this->prophesize(ContainerInterface::class);
Expand Down
Loading