IBX-8921: Add OpenAPI symfony command

.github/workflows/ci.yaml

@@ -25,6 +25,7 @@ jobs:
             - uses: ramsey/composer-install@v3
               with:
                   dependency-versions: highest
+                  composer-options: "--ignore-platform-reqs --optimize-autoloader"
 
             - name: Run code style check
               run: composer run-script check-cs -- --format=checkstyle | cs2pr

composer.json

@@ -28,6 +28,7 @@
         "ext-libxml": "*",
         "ext-simplexml": "*",
         "ext-xmlwriter": "*",
+        "api-platform/core": "dev-downgraded-deps",
         "hautelook/templated-uri-bundle": "^3.4",
         "ibexa/core": "~5.0.x-dev",
         "lexik/jwt-authentication-bundle": "^2.8",
@@ -78,7 +79,15 @@
     },
     "extra": {
         "branch-alias": {
-            "dev-main": "5.0.x-dev"
+            "dev-main": "5.0.x-dev",
+            "dev-IBX-8335-full-api-platform": "5.0.x-dev"
         }
-    }
+    },
+    "repositories": {
+        "api-platform/core": {
+            "type": "vcs",
+            "url": "https://github.com/tischsoic/core"
+        }
+    },
+    "minimum-stability": "dev"
 }

src/bundle/ApiPlatform/ClassNameResourceNameCollectionFactory.php

@@ -0,0 +1,36 @@
+<?php
+
+/**
+ * @copyright Copyright (C) Ibexa AS. All rights reserved.
+ * @license For full copyright and license information view LICENSE file distributed with this source code.
+ */
+declare(strict_types=1);
+
+namespace Ibexa\Bundle\Rest\ApiPlatform;
+
+use ApiPlatform\Metadata\Resource\Factory\ResourceNameCollectionFactoryInterface;
+use ApiPlatform\Metadata\Resource\ResourceNameCollection;
+
+/**
+ * @internal
+ */
+final class ClassNameResourceNameCollectionFactory implements ResourceNameCollectionFactoryInterface
+{
+    /**
+     * @var array<string>
+     */
+    private array $resources = [];
+
+    public function create(): ResourceNameCollection
+    {
+        return new ResourceNameCollection($this->resources);
+    }
+
+    /**
+     * @param array<string> $newResources
+     */
+    public function addResources(array $newResources): void
+    {
+        $this->resources = array_merge($this->resources, $newResources);
+    }
+}

src/bundle/ApiPlatform/Head.php

@@ -0,0 +1,174 @@
+<?php
+
+/**
+ * @copyright Copyright (C) Ibexa AS. All rights reserved.
+ * @license For full copyright and license information view LICENSE file distributed with this source code.
+ */
+declare(strict_types=1);
+
+namespace Ibexa\Bundle\Rest\ApiPlatform;
+
+use ApiPlatform\Metadata\HttpOperation;
+use ApiPlatform\Metadata\Parameters;
+use ApiPlatform\OpenApi\Attributes\Webhook;
+use ApiPlatform\OpenApi\Model\Operation as OpenApiOperation;
+use ApiPlatform\State\OptionsInterface;
+
+#[\Attribute(\Attribute::TARGET_CLASS | \Attribute::IS_REPEATABLE)]
+final class Head extends HttpOperation
+{
+    public function __construct(
+        ?string $uriTemplate = null,
+        ?array $types = null,
+        $formats = null,
+        $inputFormats = null,
+        $outputFormats = null,
+        $uriVariables = null,
+        ?string $routePrefix = null,
+        ?string $routeName = null,
+        ?array $defaults = null,
+        ?array $requirements = null,
+        ?array $options = null,
+        ?bool $stateless = null,
+        ?string $sunset = null,
+        ?string $acceptPatch = null,
+        $status = null,
+        ?string $host = null,
+        ?array $schemes = null,
+        ?string $condition = null,
+        ?string $controller = null,
+        ?array $headers = null,
+        ?array $cacheHeaders = null,
+        ?array $paginationViaCursor = null,
+        ?array $hydraContext = null,
+        ?array $openapiContext = null,
+        bool|OpenApiOperation|Webhook|null $openapi = null,
+        ?array $exceptionToStatus = null,
+        ?bool $queryParameterValidationEnabled = null,
+        ?array $links = null,
+        ?string $shortName = null,
+        ?string $class = null,
+        ?bool $paginationEnabled = null,
+        ?string $paginationType = null,
+        ?int $paginationItemsPerPage = null,
+        ?int $paginationMaximumItemsPerPage = null,
+        ?bool $paginationPartial = null,
+        ?bool $paginationClientEnabled = null,
+        ?bool $paginationClientItemsPerPage = null,
+        ?bool $paginationClientPartial = null,
+        ?bool $paginationFetchJoinCollection = null,
+        ?bool $paginationUseOutputWalkers = null,
+        ?array $order = null,
+        ?string $description = null,
+        ?array $normalizationContext = null,
+        ?array $denormalizationContext = null,
+        ?bool $collectDenormalizationErrors = null,
+        string|\Stringable|null $security = null,
+        ?string $securityMessage = null,
+        string|\Stringable|null $securityPostDenormalize = null,
+        ?string $securityPostDenormalizeMessage = null,
+        string|\Stringable|null $securityPostValidation = null,
+        ?string $securityPostValidationMessage = null,
+        ?string $deprecationReason = null,
+        ?array $filters = null,
+        ?array $validationContext = null,
+        $input = null,
+        $output = null,
+        $mercure = null,
+        $messenger = null,
+        ?bool $elasticsearch = null,
+        ?int $urlGenerationStrategy = null,
+        ?bool $read = null,
+        ?bool $deserialize = null,
+        ?bool $validate = null,
+        ?bool $write = null,
+        ?bool $serialize = null,
+        ?bool $fetchPartial = null,
+        ?bool $forceEager = null,
+        ?int $priority = null,
+        ?string $name = null,
+        $provider = null,
+        $processor = null,
+        ?OptionsInterface $stateOptions = null,
+        array|Parameters|null $parameters = null,
+        array $extraProperties = [],
+    ) {
+        parent::__construct(
+            method: self::METHOD_HEAD,
+            uriTemplate: $uriTemplate,
+            types: $types,
+            formats: $formats,
+            inputFormats: $inputFormats,
+            outputFormats: $outputFormats,
+            uriVariables: $uriVariables,
+            routePrefix: $routePrefix,
+            routeName: $routeName,
+            defaults: $defaults,
+            requirements: $requirements,
+            options: $options,
+            stateless: $stateless,
+            sunset: $sunset,
+            acceptPatch: $acceptPatch,
+            status: $status,
+            host: $host,
+            schemes: $schemes,
+            condition: $condition,
+            controller: $controller,
+            headers: $headers,
+            cacheHeaders: $cacheHeaders,
+            paginationViaCursor: $paginationViaCursor,
+            hydraContext: $hydraContext,
+            openapiContext: $openapiContext,
+            openapi: $openapi,
+            exceptionToStatus: $exceptionToStatus,
+            queryParameterValidationEnabled: $queryParameterValidationEnabled,
+            links: $links,
+            shortName: $shortName,
+            class: $class,
+            paginationEnabled: $paginationEnabled,
+            paginationType: $paginationType,
+            paginationItemsPerPage: $paginationItemsPerPage,
+            paginationMaximumItemsPerPage: $paginationMaximumItemsPerPage,
+            paginationPartial: $paginationPartial,
+            paginationClientEnabled: $paginationClientEnabled,
+            paginationClientItemsPerPage: $paginationClientItemsPerPage,
+            paginationClientPartial: $paginationClientPartial,
+            paginationFetchJoinCollection: $paginationFetchJoinCollection,
+            paginationUseOutputWalkers: $paginationUseOutputWalkers,
+            order: $order,
+            description: $description,
+            normalizationContext: $normalizationContext,
+            denormalizationContext: $denormalizationContext,
+            collectDenormalizationErrors: $collectDenormalizationErrors,
+            security: $security,
+            securityMessage: $securityMessage,
+            securityPostDenormalize: $securityPostDenormalize,
+            securityPostDenormalizeMessage: $securityPostDenormalizeMessage,
+            securityPostValidation: $securityPostValidation,
+            securityPostValidationMessage: $securityPostValidationMessage,
+            deprecationReason: $deprecationReason,
+            filters: $filters,
+            validationContext: $validationContext,
+            input: $input,
+            output: $output,
+            mercure: $mercure,
+            messenger: $messenger,
+            elasticsearch: $elasticsearch,
+            urlGenerationStrategy: $urlGenerationStrategy,
+            read: $read,
+            deserialize: $deserialize,
+            validate: $validate,
+            write: $write,
+            serialize: $serialize,
+            fetchPartial: $fetchPartial,
+            forceEager: $forceEager,
+            priority: $priority,
+            name: $name,
+            provider: $provider,
+            processor: $processor,
+            stateOptions: $stateOptions,
+            parameters: $parameters,
+            extraProperties: $extraProperties,
+        );
+    }
+}

src/bundle/ApiPlatform/OpenApiFactory.php

@@ -0,0 +1,147 @@
+<?php
+
+/**
+ * @copyright Copyright (C) Ibexa AS. All rights reserved.
+ * @license For full copyright and license information view LICENSE file distributed with this source code.
+ */
+declare(strict_types=1);
+
+namespace Ibexa\Bundle\Rest\ApiPlatform;
+
+use ApiPlatform\OpenApi\Factory\OpenApiFactoryInterface;
+use ApiPlatform\OpenApi\Model\Response;
+use ApiPlatform\OpenApi\OpenApi;
+use Symfony\Component\HttpKernel\KernelInterface;
+
+final class OpenApiFactory implements OpenApiFactoryInterface
+{
+    public function __construct(
+        private readonly OpenApiFactoryInterface $decorated,
+        private readonly SchemasCollectionFactory $schemaCollectionFactory,
+        private readonly KernelInterface $kernel,
+    ) {
+    }
+
+    /**
+     * @param array<mixed> $context
+     */
+    public function __invoke(array $context = []): OpenApi
+    {
+        $openApi = $this->decorated->__invoke($context);
+        $openApi = $this->addSchemas($openApi);
+
+        $this->insertExampleFilesContent($openApi);
+
+        return $openApi;
+    }
+
+    private function addSchemas(OpenApi $openApi): OpenApi
+    {
+        $schemasCollection = $this->schemaCollectionFactory->create();
+        $schemas = iterator_to_array($schemasCollection);
+
+        $components = $openApi->getComponents();
+        $components = $components->withSchemas(new \ArrayObject($schemas));
+
+        $openApi = $openApi->withComponents($components);
+
+        return $openApi;
+    }
+
+    private function insertExampleFilesContent(OpenApi $openApi): void
+    {
+        $paths = $openApi->getPaths();
+
+        /** @var \ApiPlatform\OpenApi\Model\PathItem $pathItem */
+        foreach ($paths->getPaths() as $path => $pathItem) {
+            $newPathItem = $pathItem;
+
+            /** @var array<string, \ApiPlatform\OpenApi\Model\Operation|null> $methods */
+            $methods = [
+                'GET' => $pathItem->getGet(),
+                'PUT' => $pathItem->getPut(),
+                'POST' => $pathItem->getPost(),
+                'DELETE' => $pathItem->getDelete(),
+                'OPTIONS' => $pathItem->getOptions(),
+                'HEAD' => $pathItem->getHead(),
+                'PATCH' => $pathItem->getPatch(),
+                'TRACE' => $pathItem->getTrace(),
+            ];
+            foreach ($methods as $method => $operation) {
+                if (empty($operation)) {
+                    continue;
+                }
+
+                $responses = $operation->getResponses();
+
+                if ($responses === null) {
+                    continue;
+                }
+
+                $newOperation = $operation;
+
+                /**
+                 * @var int $responseCode
+                 * @var \ApiPlatform\OpenApi\Model\Response|array<string, array<mixed>> $response
+                 */
+                foreach ($operation->getResponses() as $responseCode => $response) {
+                    if (!is_array($response) || !array_key_exists('content', $response)) {
+                        continue;
+                    }
+
+                    $content = $response['content'];
+                    $newContent = $content;
+
+                    foreach ($newContent as $mediaType => $responseContent) {
+                        if (array_key_exists('x-ibexa-example-file', $responseContent)) {
+                            $exampleFilePath = $this->kernel->locateResource($responseContent['x-ibexa-example-file']);
+                            $exampleFileContent = file_get_contents($exampleFilePath);
+                            $newContent[$mediaType]['example'] = $exampleFileContent;
+                            unset($newContent[$mediaType]['x-ibexa-example-file']);
+                        }
+                    }
+
+                    if ($newContent !== $content) {
+                        $newOperation = $newOperation->withResponse(
+                            $responseCode,
+                            new Response((string)$responseCode, new \ArrayObject($newContent)),
+                        );
+                    }
+                }
+
+                if ($newOperation !== $operation) {
+                    switch ($method) {
+                        case 'GET':
+                            $newPathItem = $newPathItem->withGet($newOperation);
+                            break;
+                        case 'PUT':
+                            $newPathItem = $newPathItem->withPut($newOperation);
+                            break;
+                        case 'POST':
+                            $newPathItem = $newPathItem->withPost($newOperation);
+                            break;
+                        case 'DELETE':
+                            $newPathItem = $newPathItem->withDelete($newOperation);
+                            break;
+                        case 'OPTIONS':
+                            $newPathItem = $newPathItem->withOptions($newOperation);
+                            break;
+                        case 'HEAD':
+                            $newPathItem = $newPathItem->withHead($newOperation);
+                            break;
+                        case 'PATCH':
+                            $newPathItem = $newPathItem->withPatch($newOperation);
+                            break;
+                        case 'TRACE':
+                            $newPathItem = $newPathItem->withTrace($newOperation);
+                            break;
+                    }
+                }
+            }
+
+            if ($newPathItem !== $pathItem) {
+                $paths->addPath($path, $newPathItem);
+            }
+        }
+    }
+}