Introduce new OpenApi component

composer.json

@@ -87,6 +87,7 @@
         "symfony/mime": "self.version",
         "symfony/monolog-bridge": "self.version",
         "symfony/notifier": "self.version",
+        "symfony/openapi": "self.version",
         "symfony/options-resolver": "self.version",
         "symfony/password-hasher": "self.version",
         "symfony/process": "self.version",

src/Symfony/Component/OpenApi/.gitattributes

@@ -0,0 +1,4 @@
+/Tests export-ignore
+/phpunit.xml.dist export-ignore
+/.gitattributes export-ignore
+/.gitignore export-ignore

src/Symfony/Component/OpenApi/.gitignore

@@ -0,0 +1,4 @@
+composer.lock
+phpunit.xml
+vendor/
+.phpunit.result.cache

src/Symfony/Component/OpenApi/Builder/OpenApiBuilder.php

@@ -0,0 +1,145 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\OpenApi\Builder;
+
+use Symfony\Component\OpenApi\Configurator\CallbackRequestConfigurator;
+use Symfony\Component\OpenApi\Configurator\ComponentsConfigurator;
+use Symfony\Component\OpenApi\Configurator\EncodingConfigurator;
+use Symfony\Component\OpenApi\Configurator\ExampleConfigurator;
+use Symfony\Component\OpenApi\Configurator\InfoConfigurator;
+use Symfony\Component\OpenApi\Configurator\LinkConfigurator;
+use Symfony\Component\OpenApi\Configurator\MediaTypeConfigurator;
+use Symfony\Component\OpenApi\Configurator\OperationConfigurator;
+use Symfony\Component\OpenApi\Configurator\ParameterConfigurator;
+use Symfony\Component\OpenApi\Configurator\PathItemConfigurator;
+use Symfony\Component\OpenApi\Configurator\QueryParameterConfigurator;
+use Symfony\Component\OpenApi\Configurator\QueryParametersConfigurator;
+use Symfony\Component\OpenApi\Configurator\ReferenceConfigurator;
+use Symfony\Component\OpenApi\Configurator\RequestBodyConfigurator;
+use Symfony\Component\OpenApi\Configurator\ResponseConfigurator;
+use Symfony\Component\OpenApi\Configurator\ResponsesConfigurator;
+use Symfony\Component\OpenApi\Configurator\SchemaConfigurator;
+use Symfony\Component\OpenApi\Configurator\SecuritySchemeConfigurator;
+use Symfony\Component\OpenApi\Configurator\ServerConfigurator;
+use Symfony\Component\OpenApi\Configurator\TagConfigurator;
+
+/**
+ * @author Titouan Galopin <galopintitouan@gmail.com>
+ * @author Selency Team <tech@selency.fr>
+ */
+class OpenApiBuilder implements OpenApiBuilderInterface
+{
+    public function schema(SchemaConfigurator|ReferenceConfigurator|string $definition = null): SchemaConfigurator|ReferenceConfigurator
+    {
+        return SchemaConfigurator::createFromDefinition($definition);
+    }
+
+    public function callbackRequest(): CallbackRequestConfigurator
+    {
+        return new CallbackRequestConfigurator();
+    }
+
+    public function components(): ComponentsConfigurator
+    {
+        return new ComponentsConfigurator();
+    }
+
+    public function content(): MediaTypeConfigurator
+    {
+        return new MediaTypeConfigurator();
+    }
+
+    public function encoding(): EncodingConfigurator
+    {
+        return new EncodingConfigurator();
+    }
+
+    public function example(): ExampleConfigurator
+    {
+        return new ExampleConfigurator();
+    }
+
+    public function info(): InfoConfigurator
+    {
+        return new InfoConfigurator();
+    }
+
+    public function link(): LinkConfigurator
+    {
+        return new LinkConfigurator();
+    }
+
+    public function mediaType(): MediaTypeConfigurator
+    {
+        return new MediaTypeConfigurator();
+    }
+
+    public function operation(): OperationConfigurator
+    {
+        return new OperationConfigurator($this);
+    }
+
+    public function parameter(string $name): ParameterConfigurator
+    {
+        return new ParameterConfigurator($name);
+    }
+
+    public function queryParameter(string $name): QueryParameterConfigurator
+    {
+        return new QueryParameterConfigurator($name);
+    }
+
+    public function queryParameters(): QueryParametersConfigurator
+    {
+        return new QueryParametersConfigurator($this);
+    }
+
+    public function pathItem(): PathItemConfigurator
+    {
+        return new PathItemConfigurator($this);
+    }
+
+    public function reference(string $ref): ReferenceConfigurator
+    {
+        return new ReferenceConfigurator($ref);
+    }
+
+    public function requestBody(): RequestBodyConfigurator
+    {
+        return new RequestBodyConfigurator();
+    }
+
+    public function response(): ResponseConfigurator
+    {
+        return new ResponseConfigurator();
+    }
+
+    public function responses(): ResponsesConfigurator
+    {
+        return new ResponsesConfigurator();
+    }
+
+    public function securityScheme(): SecuritySchemeConfigurator
+    {
+        return new SecuritySchemeConfigurator();
+    }
+
+    public function server(string $url): ServerConfigurator
+    {
+        return new ServerConfigurator($url);
+    }
+
+    public function tag(): TagConfigurator
+    {
+        return new TagConfigurator();
+    }
+}

src/Symfony/Component/OpenApi/Builder/OpenApiBuilderInterface.php

@@ -0,0 +1,82 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\OpenApi\Builder;
+
+use Symfony\Component\OpenApi\Configurator\CallbackRequestConfigurator;
+use Symfony\Component\OpenApi\Configurator\ComponentsConfigurator;
+use Symfony\Component\OpenApi\Configurator\EncodingConfigurator;
+use Symfony\Component\OpenApi\Configurator\ExampleConfigurator;
+use Symfony\Component\OpenApi\Configurator\InfoConfigurator;
+use Symfony\Component\OpenApi\Configurator\LinkConfigurator;
+use Symfony\Component\OpenApi\Configurator\MediaTypeConfigurator;
+use Symfony\Component\OpenApi\Configurator\OperationConfigurator;
+use Symfony\Component\OpenApi\Configurator\ParameterConfigurator;
+use Symfony\Component\OpenApi\Configurator\PathItemConfigurator;
+use Symfony\Component\OpenApi\Configurator\QueryParameterConfigurator;
+use Symfony\Component\OpenApi\Configurator\QueryParametersConfigurator;
+use Symfony\Component\OpenApi\Configurator\ReferenceConfigurator;
+use Symfony\Component\OpenApi\Configurator\RequestBodyConfigurator;
+use Symfony\Component\OpenApi\Configurator\ResponseConfigurator;
+use Symfony\Component\OpenApi\Configurator\ResponsesConfigurator;
+use Symfony\Component\OpenApi\Configurator\SchemaConfigurator;
+use Symfony\Component\OpenApi\Configurator\SecuritySchemeConfigurator;
+use Symfony\Component\OpenApi\Configurator\ServerConfigurator;
+use Symfony\Component\OpenApi\Configurator\TagConfigurator;
+
+/**
+ * @author Titouan Galopin <galopintitouan@gmail.com>
+ * @author Selency Team <tech@selency.fr>
+ */
+interface OpenApiBuilderInterface
+{
+    public function schema(SchemaConfigurator|ReferenceConfigurator|string $definition = null): SchemaConfigurator|ReferenceConfigurator;
+
+    public function callbackRequest(): CallbackRequestConfigurator;
+
+    public function components(): ComponentsConfigurator;
+
+    public function content(): MediaTypeConfigurator;
+
+    public function encoding(): EncodingConfigurator;
+
+    public function example(): ExampleConfigurator;
+
+    public function info(): InfoConfigurator;
+
+    public function link(): LinkConfigurator;
+
+    public function mediaType(): MediaTypeConfigurator;
+
+    public function operation(): OperationConfigurator;
+
+    public function parameter(string $name): ParameterConfigurator;
+
+    public function queryParameter(string $name): QueryParameterConfigurator;
+
+    public function queryParameters(): QueryParametersConfigurator;
+
+    public function pathItem(): PathItemConfigurator;
+
+    public function reference(string $ref): ReferenceConfigurator;
+
+    public function requestBody(): RequestBodyConfigurator;
+
+    public function response(): ResponseConfigurator;
+
+    public function responses(): ResponsesConfigurator;
+
+    public function securityScheme(): SecuritySchemeConfigurator;
+
+    public function server(string $url): ServerConfigurator;
+
+    public function tag(): TagConfigurator;
+}

src/Symfony/Component/OpenApi/CHANGELOG.md

@@ -0,0 +1,8 @@
+CHANGELOG
+=========
+
+6.3
+---
+
+* Add the component as experimental
+

src/Symfony/Component/OpenApi/Compiler/DocumentationCompiler.php

@@ -0,0 +1,48 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\OpenApi\Compiler;
+
+use Symfony\Component\OpenApi\Configurator\DocumentationConfigurator;
+use Symfony\Component\OpenApi\Documentation\DocumentationInterface;
+use Symfony\Component\OpenApi\Loader\ComponentsLoaderInterface;
+use Symfony\Component\OpenApi\Model\OpenApi;
+
+/**
+ * @author Titouan Galopin <galopintitouan@gmail.com>
+ * @author Selency Team <tech@selency.fr>
+ */
+class DocumentationCompiler implements DocumentationCompilerInterface
+{
+    /**
+     * @param iterable<ComponentsLoaderInterface> $componentsLoaders
+     */
+    public function __construct(private iterable $componentsLoaders = [])
+    {
+    }
+
+    public function compile(DocumentationInterface $doc): OpenApi
+    {
+        // Instanciate root configurator
+        $rootConfigurator = new DocumentationConfigurator();
+
+        // Load components for this doc
+        foreach ($this->componentsLoaders as $loader) {
+            $doc->loadComponents($rootConfigurator, $loader);
+        }
+
+        // Apply user documentation details
+        $doc->configure($rootConfigurator);
+
+        // Compile the documentation
+        return $rootConfigurator->build($doc->getIdentifier(), $doc->getVersion());
+    }
+}

src/Symfony/Component/OpenApi/Compiler/DocumentationCompilerInterface.php

@@ -0,0 +1,24 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\OpenApi\Compiler;
+
+use Symfony\Component\OpenApi\Documentation\DocumentationInterface;
+use Symfony\Component\OpenApi\Model\OpenApi;
+
+/**
+ * @author Titouan Galopin <galopintitouan@gmail.com>
+ * @author Selency Team <tech@selency.fr>
+ */
+interface DocumentationCompilerInterface
+{
+    public function compile(DocumentationInterface $doc): OpenApi;
+}

src/Symfony/Component/OpenApi/Configurator/CallbackRequestConfigurator.php

@@ -0,0 +1,47 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\OpenApi\Configurator;
+
+use Symfony\Component\OpenApi\Model\CallbackRequest;
+use Symfony\Component\OpenApi\Model\PathItem;
+use Symfony\Component\OpenApi\Model\Reference;
+
+/**
+ * @author Titouan Galopin <galopintitouan@gmail.com>
+ * @author Selency Team <tech@selency.fr>
+ */
+class CallbackRequestConfigurator
+{
+    use Traits\ExtensionsTrait;
+
+    private string $expression = '';
+    private PathItem|Reference|null $definition = null;
+
+    public function build(): CallbackRequest
+    {
+        return new CallbackRequest($this->expression, $this->definition, $this->specificationExtensions);
+    }
+
+    public function expression(string $expression): static
+    {
+        $this->expression = $expression;
+
+        return $this;
+    }
+
+    public function definition(ReferenceConfigurator|PathItemConfigurator $definition): static
+    {
+        $this->definition = $definition->build();
+
+        return $this;
+    }
+}