feat: add sf requests to components requestBodies

Author: uderline

src/Attributes/RequestBody.php

@@ -48,6 +48,6 @@ public function jsonSerialize(): array
         }
 
         // TODO: deal with media content or any other Types (cf. $this->type)
-        return ['content' => $this->schema];
+        return $this->schema->jsonSerialize();
     }
 }

src/Attributes/Response.php

@@ -7,7 +7,7 @@
 use Attribute;
 use Countable;
 use JsonSerializable;
-use OpenApiGenerator\Type;
+use OpenApiGenerator\RefProperty;
 use OpenApiGenerator\Types\ItemsType;
 use OpenApiGenerator\Types\SchemaType;
 
@@ -57,7 +57,7 @@ public function jsonSerialize(): array
         ];
 
         if ($this->schema) {
-            $array[$this->code]['content'] = $this->schema;
+            $array[$this->code] = array_merge($array[$this->code], $this->schema->jsonSerialize());
         }
 
         if ($this->extra) {

src/Attributes/Schema.php

@@ -7,6 +7,7 @@
 use Attribute;
 use Countable;
 use JsonSerializable;
+use OpenApiGenerator\RefProperty;
 use OpenApiGenerator\Types\SchemaType;
 
 /**
@@ -84,8 +85,10 @@ public function jsonSerialize(): array
         }
 
         return [
-            $this->getMediaType() => [
-                'schema' => $schema
+            "content" => [
+                $this->getMediaType() => [
+                    'schema' => $schema
+                ]
             ]
         ];
     }

src/ComponentFactory.php

@@ -46,4 +46,16 @@ public static function build(ReflectionClass $reflectionClass): Schema
 
         return $builder->getComponent();
     }
+
+    public static function buildRequest(string $refComponentName): Schema
+    {
+        $builder = new SchemaBuilder(false);
+
+        $schema = new Schema();
+        $schema->addProperty(new RefProperty($refComponentName));
+
+        $builder->addSchema($schema, $refComponentName);
+
+        return $builder->getComponent();
+    }
 }

src/Generator.php

@@ -13,6 +13,7 @@
 use ReflectionAttribute;
 use ReflectionClass;
 use ReflectionException;
+use Symfony\Component\HttpFoundation\Request;
 
 class Generator
 {
@@ -105,6 +106,11 @@ private function loadSchema(ReflectionClass $reflectionClass): void
         if (count($reflectionClass->getAttributes(Schema::class))) {
             $component = ComponentFactory::build($reflectionClass);
             $this->description['components']['schemas'][$component->getName()] = $component;
+
+            if ($reflectionClass->isSubclassOf(Request::class)) {
+                $component = ComponentFactory::buildRequest($component->getName());
+                $this->description['components']['requestBodies'][$component->getName()] = $component;
+            }
         }
     }
 

src/GeneratorHttp.php

@@ -16,7 +16,6 @@
 use OpenApiGenerator\Attributes\PropertyInterface;
 use OpenApiGenerator\Attributes\PropertyItems;
 use OpenApiGenerator\Attributes\PUT;
-use OpenApiGenerator\Attributes\RefProperty;
 use OpenApiGenerator\Attributes\RequestBody;
 use OpenApiGenerator\Attributes\Response;
 use OpenApiGenerator\Attributes\Route;
@@ -113,42 +112,32 @@ public function append(ReflectionClass $reflectionClass): void
 
     /**
      * OPAG supports Symfony Request class. This method will build the RequestBody from the Symfony Request class
-     *
-     * @throws ReflectionException|IllegalFieldException
+     * The request object will be added as a reference to the RequestBody
      */
     private function buildRequestBodyFromSymfonyRequest(ReflectionMethod $method): ?RequestBody
     {
         $requestBody = new RequestBody();
 
         // Get the first parameter that is a subclass of Symfony Request
-        $requestClass = array_filter(
+        $symfonyRequests = array_filter(
             $method->getParameters(),
-            static fn(ReflectionParameter $parameter): bool => is_subclass_of(
-                $parameter->getType()->getName(),
-                Request::class
-            )
+            fn(ReflectionParameter $parameter): bool => is_subclass_of($parameter->getType()->getName(), Request::class)
         );
-        $requestClass = reset($requestClass);
-        if (!$requestClass) {
+        if (!count($symfonyRequests)) {
             return null;
         }
 
-        // Get the Schema attribute from the Symfony Request class
-        $requestReflection = new ReflectionClass($requestClass->getType()->getName());
-        $schemaAttributes = $requestReflection->getAttributes(Schema::class);
-        $schemaAttribute = reset($schemaAttributes);
-        if (!$schemaAttribute) {
+        $symfonyRequest = reset($symfonyRequests);
+        if (empty((new ReflectionClass($symfonyRequest->getType()->getName()))->getAttributes(Schema::class))) {
             return null;
         }
 
-        // Build the schema
-        $schema = $schemaAttribute->newInstance();
-        $builder = new SchemaBuilder(false);
-        $builder->addSchema($schema, $requestClass->getType()->getName());
-        $builder->addProperty(new RefProperty($schema->getName()));
-
-        // Set the schema to the RequestBody and return it
-        $requestBody->setSchema($builder->getComponent());
+        $schema = new Schema();
+        $schema->setNoMedia(true);
+        $requestBody->setSchema($schema);
+        $property = new RefProperty($symfonyRequest->getType()->getName());
+        $property->setComponentRoutePrefix("#/components/requestBodies/");
+        $requestBody->addProperty($property);
 
         return $requestBody;
     }

src/Attributes/RefProperty.php src/RefProperty.phpsrc/Attributes/RefProperty.php renamed to src/RefProperty.php

@@ -2,28 +2,32 @@
 
 declare(strict_types=1);
 
-namespace OpenApiGenerator\Attributes;
+namespace OpenApiGenerator;
 
 use Attribute;
 use JsonSerializable;
+use OpenApiGenerator\Attributes\PropertyInterface;
 use OpenApiGenerator\Types\PropertyType;
 
-/**
- * This represents an open api property.
- */
-#[Attribute(Attribute::IS_REPEATABLE | Attribute::TARGET_ALL)]
 class RefProperty implements PropertyInterface, JsonSerializable
 {
+    private string $route = "#/components/schemas/";
+
     public function __construct(
         private string $ref,
     ) {
         $ref = explode('\\', $this->ref);
         $this->ref = end($ref);
     }
 
+    public function setComponentRoutePrefix(string $route): void
+    {
+        $this->route = $route;
+    }
+
     public function jsonSerialize(): array
     {
-        return ['$ref' => "#/components/schemas/$this->ref"];
+        return ['$ref' => "{$this->route}{$this->ref}"];
     }
 
     public function getType(): string

tests/Unit/ParameterTest.php

@@ -4,21 +4,11 @@
 
 namespace Unit;
 
-use OpenApiGenerator\Attributes\MediaProperty;
 use OpenApiGenerator\Attributes\Parameter;
-use OpenApiGenerator\Attributes\Property;
-use OpenApiGenerator\Attributes\PropertyInterface;
-use OpenApiGenerator\Attributes\PropertyItems;
-use OpenApiGenerator\Attributes\RefProperty;
-use OpenApiGenerator\Attributes\Schema;
 use OpenApiGenerator\IllegalFieldException;
-use OpenApiGenerator\Type;
-use OpenApiGenerator\Types\MediaType;
-use OpenApiGenerator\Types\SchemaType;
 use PHPUnit\Framework\Attributes\DataProvider;
 use PHPUnit\Framework\Attributes\Test;
 use PHPUnit\Framework\TestCase;
-use stdClass;
 
 class ParameterTest extends TestCase
 {

tests/Unit/PropertyTest.php

@@ -4,10 +4,10 @@
 
 namespace Unit;
 
-use OpenApiGenerator\Attributes\Info;
 use OpenApiGenerator\Attributes\Property;
 use OpenApiGenerator\Attributes\PropertyItems;
 use OpenApiGenerator\IllegalFieldException;
+use OpenApiGenerator\RefProperty;
 use OpenApiGenerator\Tests\Examples\Dummy\DummyBackedEnum;
 use OpenApiGenerator\Tests\Examples\Dummy\DummyRefComponent;
 use PHPUnit\Framework\Attributes\Test;
@@ -62,7 +62,18 @@ public function json_must_return_the_property_with_a_ref(): void
             '$ref' => '#/components/schemas/DummyRefComponent'
         ], $property->jsonSerialize());
     }
-    
+
+    #[Test]
+    public function json_contains_a_ref_property_with_a_different_prefix(): void
+    {
+        $property = new RefProperty(StdClass::class);
+        $property->setComponentRoutePrefix("#/components/requestBodies/");
+
+        $this->assertEqualsCanonicalizing([
+            '$ref' => '#/components/requestBodies/StdClass'
+        ], $property->jsonSerialize());
+    }
+
     #[Test]
     public function json_must_return_the_property_with_a_nullable_ref(): void
     {

tests/Unit/RequestBodyTest.php

@@ -40,7 +40,7 @@ public function is_empty_will_return_false_if_a_schema_exist(): void
     }
 
     #[Test]
-    public function json_will_return_an_emoty_array_if_the_body_is_empty(): void
+    public function json_will_return_an_empty_array_if_the_body_is_empty(): void
     {
         $requestBody = new RequestBody();