fix(openapi): yaml parameters extractor (#5487)

api-platform · Mar 28, 2023 · f128e3b · f128e3b
1 parent a7f4e0b
commit f128e3b
Show file tree

Hide file tree

Showing 3 changed files with 55 additions and 0 deletions.
diff --git a/src/Metadata/Extractor/YamlResourceExtractor.php b/src/Metadata/Extractor/YamlResourceExtractor.php
@@ -19,6 +19,7 @@
 use ApiPlatform\Metadata\Tests\Fixtures\StateOptions;
 use ApiPlatform\OpenApi\Model\ExternalDocumentation;
 use ApiPlatform\OpenApi\Model\Operation as OpenApiOperation;
+use ApiPlatform\OpenApi\Model\Parameter;
 use ApiPlatform\OpenApi\Model\RequestBody;
 use ApiPlatform\State\OptionsInterface;
 use Symfony\Component\Yaml\Exception\ParseException;
@@ -235,6 +236,28 @@ private function buildOpenapi(array $resource): bool|OpenApiOperation|null
             unset($resource['openapi'][$key]);
         }
 
+        if (\array_key_exists('parameters', $resource['openapi']) && \is_array($openapiParameters = $resource['openapi']['parameters'] ?? [])) {
+            $parameters = [];
+            foreach ($openapiParameters as $parameter) {
+                $parameters[] = new Parameter(
+                    name: $parameter['name'],
+                    in: $parameter['in'],
+                    description: $parameter['description'] ?? '',
+                    required: $parameter['required'] ?? false,
+                    deprecated: $parameter['deprecated'] ?? false,
+                    allowEmptyValue: $parameter['allowEmptyValue'] ?? false,
+                    schema: $parameter['schema'] ?? [],
+                    style: $parameter['style'] ?? null,
+                    explode: $parameter['explode'] ?? false,
+                    allowReserved: $parameter['allowReserved '] ?? false,
+                    example: $parameter['example'] ?? null,
+                    examples: isset($parameter['examples']) ? new \ArrayObject($parameter['examples']) : null,
+                    content: isset($parameter['content']) ? new \ArrayObject($parameter['content']) : null
+                );
+            }
+            $resource['openapi']['parameters'] = $parameters;
+        }
+
         return new OpenApiOperation(...$resource['openapi']);
     }
 

diff --git a/src/Metadata/Tests/Extractor/YamlExtractorTest.php b/src/Metadata/Tests/Extractor/YamlExtractorTest.php
@@ -473,6 +473,24 @@ public function testValidYaml(): void
         ], $extractor->getResources());
     }
 
+    public function testOpenApiParameters(): void
+    {
+        $extractor = new YamlResourceExtractor([__DIR__.'/yaml/openapi.yaml']);
+        $resources = $extractor->getResources();
+
+        $this->assertArrayHasKey(Program::class, $resources);
+        $this->assertArrayHasKey('openapi', $resources[Program::class][0]);
+
+        $this->assertIsObject($resources[Program::class][0]['operations'][0]['openapi']);
+
+        $operation = $resources[Program::class][0]['operations'][0]['openapi'];
+        $this->assertIsArray($operation->getParameters());
+
+        $this->assertEquals('author', $operation->getParameters()[0]->getName());
+        $this->assertEquals('path', $operation->getParameters()[0]->getIn());
+        $this->assertEquals('john-doe', $operation->getParameters()[0]->getExample());
+    }
+
     public function testInputAndOutputAreBooleans(): void
     {
         $extractor = new YamlResourceExtractor([__DIR__.'/yaml/input-and-output-are-booleans.yaml']);

diff --git a/src/Metadata/Tests/Extractor/yaml/openapi.yaml b/src/Metadata/Tests/Extractor/yaml/openapi.yaml
@@ -0,0 +1,14 @@
+resources:
+    ApiPlatform\Metadata\Tests\Fixtures\ApiResource\Program:
+        -   uriTemplate: /users/{author}/programs.{_format}
+            uriVariables: ['author']
+            operations:
+                ApiPlatform\Metadata\Post:
+                    openapi:
+                        parameters:
+                            username:
+                                name: author
+                                in: path
+                                example: "john-doe"
+                                examples: ["John-doe"]
+                                foo: "bar"