Use the Doctrine default value as default value in Swagger doc

Author: aaa2000

src/Bridge/Doctrine/Orm/Metadata/Property/DoctrineOrmPropertyMetadataFactory.php

@@ -76,6 +76,13 @@ public function create(string $resourceClass, string $property, array $options =
             $propertyMetadata = $propertyMetadata->withIdentifier(false);
         }
 
+        if ($doctrineClassMetadata instanceof ClassMetadataInfo && \in_array($property, $doctrineClassMetadata->getFieldNames(), true)) {
+            $fieldMapping = $doctrineClassMetadata->getFieldMapping($property);
+            if (\array_key_exists('options', $fieldMapping) && \array_key_exists('default', $fieldMapping['options'])) {
+                $propertyMetadata = $propertyMetadata->withDefault($fieldMapping['options']['default']);
+            }
+        }
+
         return $propertyMetadata;
     }
 }

tests/Bridge/Doctrine/Orm/Metadata/Property/DoctrineOrmPropertyMetadataFactoryTest.php

@@ -17,6 +17,7 @@
 use ApiPlatform\Core\Metadata\Property\Factory\PropertyMetadataFactoryInterface;
 use ApiPlatform\Core\Metadata\Property\PropertyMetadata;
 use ApiPlatform\Core\Tests\Fixtures\TestBundle\Entity\Dummy;
+use ApiPlatform\Core\Tests\Fixtures\TestBundle\Entity\DummyPropertyWithDefaultValue;
 use Doctrine\Common\Persistence\ManagerRegistry;
 use Doctrine\Common\Persistence\Mapping\ClassMetadata;
 use Doctrine\Common\Persistence\ObjectManager;
@@ -73,6 +74,7 @@ public function testCreateIsWritable()
 
         $classMetadata = $this->prophesize(ClassMetadataInfo::class);
         $classMetadata->getIdentifier()->shouldBeCalled()->willReturn(['id']);
+        $classMetadata->getFieldNames()->shouldBeCalled()->willReturn([]);
 
         $objectManager = $this->prophesize(ObjectManager::class);
         $objectManager->getClassMetadata(Dummy::class)->shouldBeCalled()->willReturn($classMetadata->reveal());
@@ -88,6 +90,31 @@ public function testCreateIsWritable()
         $this->assertEquals($doctrinePropertyMetadata->isWritable(), false);
     }
 
+    public function testCreateWithDefaultOption()
+    {
+        $propertyMetadata = new PropertyMetadata();
+
+        $propertyMetadataFactory = $this->prophesize(PropertyMetadataFactoryInterface::class);
+        $propertyMetadataFactory->create(DummyPropertyWithDefaultValue::class, 'dummyDefaultOption', [])->shouldBeCalled()->willReturn($propertyMetadata);
+
+        $classMetadata = new ClassMetadataInfo(DummyPropertyWithDefaultValue::class);
+        $classMetadata->fieldMappings = [
+            'dummyDefaultOption' => ['options' => ['default' => 'default value']],
+        ];
+
+        $objectManager = $this->prophesize(ObjectManager::class);
+        $objectManager->getClassMetadata(DummyPropertyWithDefaultValue::class)->shouldBeCalled()->willReturn($classMetadata);
+
+        $managerRegistry = $this->prophesize(ManagerRegistry::class);
+        $managerRegistry->getManagerForClass(DummyPropertyWithDefaultValue::class)->shouldBeCalled()->willReturn($objectManager->reveal());
+
+        $doctrineOrmPropertyMetadataFactory = new DoctrineOrmPropertyMetadataFactory($managerRegistry->reveal(), $propertyMetadataFactory->reveal());
+
+        $doctrinePropertyMetadata = $doctrineOrmPropertyMetadataFactory->create(DummyPropertyWithDefaultValue::class, 'dummyDefaultOption');
+
+        $this->assertEquals($doctrinePropertyMetadata->getDefault(), 'default value');
+    }
+
     public function testCreateClassMetadataInfo()
     {
         $propertyMetadata = new PropertyMetadata();
@@ -98,6 +125,7 @@ public function testCreateClassMetadataInfo()
         $classMetadata = $this->prophesize(ClassMetadataInfo::class);
         $classMetadata->getIdentifier()->shouldBeCalled()->willReturn(['id']);
         $classMetadata->isIdentifierNatural()->shouldBeCalled()->willReturn(true);
+        $classMetadata->getFieldNames()->shouldBeCalled()->willReturn([]);
 
         $objectManager = $this->prophesize(ObjectManager::class);
         $objectManager->getClassMetadata(Dummy::class)->shouldBeCalled()->willReturn($classMetadata->reveal());

tests/Fixtures/TestBundle/Entity/DummyPropertyWithDefaultValue.php

@@ -49,6 +49,13 @@ class DummyPropertyWithDefaultValue
      */
     public $foo = 'foo';
 
+    /**
+     * @var string A dummy with a Doctrine default options
+     *
+     * @ORM\Column(options={"default"="default value"})
+     */
+    public $dummyDefaultOption;
+
     /**
      * @return int
      */