Merge pull request #753 from Simperfit/feature/728-show-in-out-in-swagger-doc

Support for normalization groups and filters in the Swagger doc

Author: dunglas

features/swagger/doc.feature

@@ -15,13 +15,34 @@ Feature: Documentation support
     And the JSON node "info.title" should be equal to "My Dummy API"
     And the JSON node "info.description" should be equal to "This is a test API."
     # Supported classes
+    And the Swagger class "AbstractDummy" exists
     And the Swagger class "CircularReference" exists
+    And the Swagger class "CircularReference_a0dd2858dcb0d966f739c1ac906afa2e" exists
+    And the Swagger class "CompositeItem" exists
+    And the Swagger class "CompositeLabel" exists
+    And the Swagger class "ConcreteDummy" exists
     And the Swagger class "CustomIdentifierDummy" exists
-    And the Swagger class "CustomNormalizedDummy" exists
+    And the Swagger class "CustomNormalizedDummy_601856395b57c6b15175297eb6c9890e" exists
+    And the Swagger class "CustomNormalizedDummy_db9cba1a967111a02380774784c47722" exists
     And the Swagger class "CustomWritableIdentifierDummy" exists
     And the Swagger class "Dummy" exists
     And the Swagger class "RelatedDummy" exists
-    And the Swagger class "RelationEmbedder" exists
+    And the Swagger class "DummyTableInheritance" exists
+    And the Swagger class "DummyTableInheritanceChild" exists
+    And the Swagger class "OverriddenOperationDummy_441e1f98db3d0250bcb18dca087687c3" exists
+    And the Swagger class "OverriddenOperationDummy_45f46ed6dc6f412229a8c12cd5583586" exists
+    And the Swagger class "OverriddenOperationDummy_868796b9924a520acbb96f8b75dade9f" exists
+    And the Swagger class "OverriddenOperationDummy_ff74003f36aebfe31c696fae1f701ae4" exists
+    And the Swagger class "RelatedDummy" exists
+    And the Swagger class "NoCollectionDummy" exists
+    And the Swagger class "RelatedToDummyFriend" exists
+    And the Swagger class "RelatedToDummyFriend_ad38b7a2760884e744c577a92e02b8c4" exists
+    And the Swagger class "DummyFriend" exists
+    And the Swagger class "RelationEmbedder_ced9cba177bf3134e609fccf878df9a7" exists
+    And the Swagger class "RelationEmbedder_f02fd88a2291463447338402aee9a220" exists
+    And the Swagger class "User_4320517091b72c69e9f0c72aac0141e8" exists
+    And the Swagger class "User_7ce91261c0e731d95bb24b83b1f637b2" exists
+    And the Swagger class "UuidIdentifierDummy" exists
     And the Swagger class "ThirdLevel" exists
     And the Swagger class "ParentDummy" doesn't exist
     And the Swagger class "UnknownDummy" doesn't exist
@@ -30,10 +51,14 @@ Feature: Documentation support
     And the Swagger path "/api/custom-call/{id}" exists
     And the JSON node "paths./api/custom-call/{id}.get" should exist
     And the JSON node "paths./api/custom-call/{id}.put" should exist
-
     # Properties
     And "id" property exists for the Swagger class "Dummy"
     And "name" property is required for Swagger class "Dummy"
+    # Filters
+    And the JSON node "paths./dummies.get.parameters[0].name" should be equal to "id"
+    And the JSON node "paths./dummies.get.parameters[0].in" should be equal to "query"
+    And the JSON node "paths./dummies.get.parameters[0].required" should be false
+    And the JSON node "paths./dummies.get.parameters[0].type" should be equal to "integer"
 
   Scenario: Swagger UI is enabled for the doc endpoint
     Given I add "Accept" header equal to "text/html"

src/Bridge/Doctrine/Orm/Filter/BooleanFilter.php

@@ -57,7 +57,7 @@ public function getDescription(string $resourceClass) : array
 
             $description[$property] = [
                 'property' => $property,
-                'type' => 'boolean',
+                'type' => 'bool',
                 'required' => false,
             ];
         }

src/Bridge/Doctrine/Orm/Filter/DateFilter.php

@@ -194,7 +194,7 @@ protected function getFilterDescription(string $property, string $period) : arra
         return [
             sprintf('%s[%s]', $property, $period) => [
                 'property' => $property,
-                'type' => '\DateTime',
+                'type' => \DateTimeInterface::class,
                 'required' => false,
             ],
         ];

src/Bridge/Doctrine/Orm/Filter/NumericFilter.php

@@ -71,14 +71,34 @@ public function getDescription(string $resourceClass) : array
 
             $description[$property] = [
                 'property' => $property,
-                'type' => $metadata->getTypeOfField($propertyParts['field']),
+                'type' => $this->getType($metadata->getTypeOfField($propertyParts['field'])),
                 'required' => false,
             ];
         }
 
         return $description;
     }
 
+    /**
+     * Gets the PHP type corresponding to this Doctrine type.
+     *
+     * @param string $doctrineType
+     *
+     * @return string
+     */
+    private function getType(string $doctrineType) : string
+    {
+        if (DBALType::DECIMAL === $doctrineType) {
+            return 'string';
+        }
+
+        if (DBALType::FLOAT === $doctrineType) {
+            return 'float';
+        }
+
+        return 'int';
+    }
+
     /**
      * {@inheritdoc}
      */

src/Bridge/Doctrine/Orm/Filter/SearchFilter.php

@@ -15,6 +15,7 @@
 use ApiPlatform\Core\Bridge\Doctrine\Orm\Util\QueryNameGeneratorInterface;
 use ApiPlatform\Core\Exception\InvalidArgumentException;
 use Doctrine\Common\Persistence\ManagerRegistry;
+use Doctrine\DBAL\Types\Type;
 use Doctrine\ORM\QueryBuilder;
 use Psr\Log\LoggerInterface;
 use Symfony\Component\HttpFoundation\RequestStack;
@@ -91,14 +92,14 @@ public function getDescription(string $resourceClass) : array
             }
 
             if ($metadata->hasField($field)) {
-                $typeOfField = $metadata->getTypeOfField($field);
+                $typeOfField = $this->getType($metadata->getTypeOfField($field));
                 $strategy = $this->properties[$property] ?? self::STRATEGY_EXACT;
-                $filterParameterNames = [
-                    $property,
-                ];
+                $filterParameterNames = [$property];
+
                 if (self::STRATEGY_EXACT === $strategy) {
                     $filterParameterNames[] = $property.'[]';
                 }
+
                 foreach ($filterParameterNames as $filterParameterName) {
                     $description[$filterParameterName] = [
                         'property' => $property,
@@ -116,7 +117,7 @@ public function getDescription(string $resourceClass) : array
                 foreach ($filterParameterNames as $filterParameterName) {
                     $description[$filterParameterName] = [
                         'property' => $property,
-                        'type' => 'iri',
+                        'type' => 'string',
                         'required' => false,
                         'strategy' => self::STRATEGY_EXACT,
                     ];
@@ -127,6 +128,40 @@ public function getDescription(string $resourceClass) : array
         return $description;
     }
 
+    /**
+     * Converts a Doctrine type in PHP type.
+     *
+     * @param string $doctrineType
+     *
+     * @return string
+     */
+    private function getType(string $doctrineType) : string
+    {
+        switch ($doctrineType) {
+            case Type::TARRAY:
+                return 'array';
+
+            case Type::BIGINT:
+            case Type::INTEGER:
+            case Type::SMALLINT:
+                return 'int';
+
+            case Type::BOOLEAN:
+                return 'bool';
+
+            case Type::DATE:
+            case Type::TIME:
+            case Type::DATETIME:
+            case Type::DATETIMETZ:
+                    return \DateTimeInterface::class;
+
+            case Type::FLOAT:
+                return 'float';
+        }
+
+        return 'string';
+    }
+
     /**
      * {@inheritdoc}
      */

src/Bridge/Symfony/Bundle/Resources/config/swagger.xml

@@ -14,6 +14,7 @@
             <argument type="service" id="api_platform.operation_method_resolver" />
             <argument type="service" id="api_platform.operation_path_resolver" />
             <argument type="service" id="api_platform.router" />
+            <argument type="service" id="api_platform.filters" />
 
             <tag name="serializer.normalizer" priority="16" />
         </service>

src/Hydra/Serializer/CollectionFiltersNormalizer.php

@@ -63,7 +63,6 @@ public function normalize($object, $format = null, array $context = [])
         $resourceMetadata = $this->resourceMetadataFactory->create($resourceClass);
 
         $operationName = $context['collection_operation_name'] ?? null;
-
         if (null === $operationName) {
             $resourceFilters = $resourceMetadata->getAttribute('filters', []);
         } else {