Merge pull request #38 from pongee/jsonapi

vsouz4 · web-flow · commit af53a2d29dac · 2021-05-31T07:34:20.000-03:00
Add "application/vnd.api+json" support
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,6 +4,10 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
+## [5.7.0] - 2021-05-28
+### Added
+- Support for `application/vnd.api+json` MIME type.
+
 ## [5.6.1] - 2021-05-25
 ### Fixed
 - Minimum and Maximum constraints work for floats
diff --git a/example/gen/src/Serializer/ContentType/AbstractJsonContentTypeSerializer.php b/example/gen/src/Serializer/ContentType/AbstractJsonContentTypeSerializer.php
@@ -0,0 +1,61 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file was generated by docler-labs/api-client-generator.
+ *
+ * Do not edit it manually.
+ */
+
+namespace OpenApi\PetStoreClient\Serializer\ContentType;
+
+use OpenApi\PetStoreClient\Schema\SerializableInterface;
+use Psr\Http\Message\StreamInterface;
+
+abstract class AbstractJsonContentTypeSerializer implements ContentTypeSerializerInterface
+{
+    private const JSON_DEPTH = 512;
+
+    private const JSON_OPTIONS = JSON_BIGINT_AS_STRING | JSON_PRESERVE_ZERO_FRACTION | JSON_UNESCAPED_UNICODE;
+
+    /**
+     * @throws SerializeException
+     */
+    public function encode(SerializableInterface $body): string
+    {
+        $encodedData   = \json_encode($body->toArray(), self::JSON_OPTIONS);
+        $lastErrorCode = \json_last_error();
+        if ($lastErrorCode === JSON_ERROR_NONE && $encodedData !== false) {
+            return $encodedData;
+        }
+        throw new SerializeException('JSON encode error: ' . $this->getErrorMessage($lastErrorCode));
+    }
+
+    /**
+     * @throws SerializeException
+     */
+    public function decode(StreamInterface $body): array
+    {
+        $body->rewind();
+        // According to RFC7159 a JSON value MUST be an object, array, number, string,
+        // or one of the following three literal names: false, null, true.
+        $result        = \json_decode($body->getContents(), true, self::JSON_DEPTH, self::JSON_OPTIONS);
+        $lastErrorCode = \json_last_error();
+        if ($lastErrorCode === JSON_ERROR_NONE) {
+            if (! \is_array($result)) {
+                $result = [ContentTypeSerializerInterface::LITERAL_VALUE_KEY => $result];
+            }
+
+            return $result;
+        }
+        throw new SerializeException('JSON decode error: ' . $this->getErrorMessage($lastErrorCode));
+    }
+
+    private function getErrorMessage(int $errorCode): string
+    {
+        $errorMessages = [JSON_ERROR_NONE => 'No errors', JSON_ERROR_DEPTH => 'Maximum stack depth exceeded', JSON_ERROR_STATE_MISMATCH => 'Underflow or the modes mismatch', JSON_ERROR_CTRL_CHAR => 'Unexpected control character found', JSON_ERROR_SYNTAX => 'Syntax error, malformed JSON', JSON_ERROR_UTF8 => 'Malformed UTF-8 characters, possibly incorrectly encoded', JSON_ERROR_RECURSION => 'Recursive reference was found', JSON_ERROR_INF_OR_NAN => 'NaN or Inf was found', JSON_ERROR_UNSUPPORTED_TYPE => 'Unsupported type was found'];
+
+        return $errorMessages[$errorCode] ?? 'Unknown error';
+    }
+}
diff --git a/example/gen/src/Serializer/ContentType/JsonContentTypeSerializer.php b/example/gen/src/Serializer/ContentType/JsonContentTypeSerializer.php
@@ -10,56 +10,12 @@
 
 namespace OpenApi\PetStoreClient\Serializer\ContentType;
 
-use OpenApi\PetStoreClient\Schema\SerializableInterface;
-use Psr\Http\Message\StreamInterface;
-
-class JsonContentTypeSerializer implements ContentTypeSerializerInterface
+class JsonContentTypeSerializer extends AbstractJsonContentTypeSerializer
 {
-    const MIME_TYPE = 'application/json';
-
-    const JSON_DEPTH = 512;
-
-    const JSON_OPTIONS = JSON_BIGINT_AS_STRING | JSON_PRESERVE_ZERO_FRACTION | JSON_UNESCAPED_UNICODE;
-
-    public function encode(SerializableInterface $body): string
-    {
-        $encodedData   = \json_encode($body->toArray(), self::JSON_OPTIONS);
-        $lastErrorCode = \json_last_error();
-        if ($lastErrorCode === JSON_ERROR_NONE && $encodedData !== false) {
-            return $encodedData;
-        }
-        throw new SerializeException('JSON encode error: ' . $this->getErrorMessage($lastErrorCode));
-    }
-
-    /**
-     * @throws SerializeException
-     */
-    public function decode(StreamInterface $body): array
-    {
-        $body->rewind();
-        // According to RFC7159 a JSON value MUST be an object, array, number, string,
-        // or one of the following three literal names: false, null, true.
-        $result        = \json_decode($body->getContents(), true, self::JSON_DEPTH, self::JSON_OPTIONS);
-        $lastErrorCode = \json_last_error();
-        if ($lastErrorCode === JSON_ERROR_NONE) {
-            if (! \is_array($result)) {
-                $result = [ContentTypeSerializerInterface::LITERAL_VALUE_KEY => $result];
-            }
-
-            return $result;
-        }
-        throw new SerializeException('JSON decode error: ' . $this->getErrorMessage($lastErrorCode));
-    }
+    public const MIME_TYPE = 'application/json';
 
     public function getMimeType(): string
     {
         return self::MIME_TYPE;
     }
-
-    private function getErrorMessage(int $errorCode): string
-    {
-        $errorMessages = [JSON_ERROR_NONE => 'No errors', JSON_ERROR_DEPTH => 'Maximum stack depth exceeded', JSON_ERROR_STATE_MISMATCH => 'Underflow or the modes mismatch', JSON_ERROR_CTRL_CHAR => 'Unexpected control character found', JSON_ERROR_SYNTAX => 'Syntax error, malformed JSON', JSON_ERROR_UTF8 => 'Malformed UTF-8 characters, possibly incorrectly encoded', JSON_ERROR_RECURSION => 'Recursive reference was found', JSON_ERROR_INF_OR_NAN => 'NaN or Inf was found', JSON_ERROR_UNSUPPORTED_TYPE => 'Unsupported type was found'];
-
-        return $errorMessages[$errorCode] ?? 'Unknown error';
-    }
 }
diff --git a/src/Command/GenerateCommand.php b/src/Command/GenerateCommand.php
@@ -12,6 +12,7 @@
 use DoclerLabs\ApiClientGenerator\MetaTemplateFacade;
 use DoclerLabs\ApiClientGenerator\Output\Copy\Serializer\ContentType\FormUrlencodedContentTypeSerializer;
 use DoclerLabs\ApiClientGenerator\Output\Copy\Serializer\ContentType\JsonContentTypeSerializer;
+use DoclerLabs\ApiClientGenerator\Output\Copy\Serializer\ContentType\VdnApiJsonContentTypeSerializer;
 use DoclerLabs\ApiClientGenerator\Output\Copy\Serializer\ContentType\XmlContentTypeSerializer;
 use DoclerLabs\ApiClientGenerator\Output\Meta\MetaFileCollection;
 use DoclerLabs\ApiClientGenerator\Output\MetaFilePrinter;
@@ -209,6 +210,7 @@ private function getBlacklistedFiles(Specification $specification): array
             XmlContentTypeSerializer::MIME_TYPE            => XmlContentTypeSerializer::class,
             FormUrlencodedContentTypeSerializer::MIME_TYPE => FormUrlencodedContentTypeSerializer::class,
             JsonContentTypeSerializer::MIME_TYPE           => JsonContentTypeSerializer::class,
+            VdnApiJsonContentTypeSerializer::MIME_TYPE     => VdnApiJsonContentTypeSerializer::class,
         ];
 
         $allContentTypes = $specification->getAllContentTypes();
diff --git a/src/Entity/Request.php b/src/Entity/Request.php
@@ -7,6 +7,7 @@
 use DoclerLabs\ApiClientGenerator\Input\InvalidSpecificationException;
 use DoclerLabs\ApiClientGenerator\Output\Copy\Serializer\ContentType\FormUrlencodedContentTypeSerializer;
 use DoclerLabs\ApiClientGenerator\Output\Copy\Serializer\ContentType\JsonContentTypeSerializer;
+use DoclerLabs\ApiClientGenerator\Output\Copy\Serializer\ContentType\VdnApiJsonContentTypeSerializer;
 use DoclerLabs\ApiClientGenerator\Output\Copy\Serializer\ContentType\XmlContentTypeSerializer;
 
 class Request
@@ -31,6 +32,7 @@ class Request
         JsonContentTypeSerializer::MIME_TYPE,
         FormUrlencodedContentTypeSerializer::MIME_TYPE,
         XmlContentTypeSerializer::MIME_TYPE,
+        VdnApiJsonContentTypeSerializer::MIME_TYPE,
     ];
     private string               $path;
     private string               $method;
diff --git a/src/Generator/ServiceProviderGenerator.php b/src/Generator/ServiceProviderGenerator.php
@@ -6,7 +6,6 @@
 use DoclerLabs\ApiClientGenerator\Ast\Builder\CodeBuilder;
 use DoclerLabs\ApiClientGenerator\Ast\Builder\MethodBuilder;
 use DoclerLabs\ApiClientGenerator\Entity\Field;
-use DoclerLabs\ApiClientGenerator\Entity\Operation;
 use DoclerLabs\ApiClientGenerator\Generator\Implementation\ContainerImplementationStrategy;
 use DoclerLabs\ApiClientGenerator\Generator\Implementation\HttpMessageImplementationStrategy;
 use DoclerLabs\ApiClientGenerator\Input\Specification;
@@ -17,6 +16,7 @@
 use DoclerLabs\ApiClientGenerator\Output\Copy\Serializer\BodySerializer;
 use DoclerLabs\ApiClientGenerator\Output\Copy\Serializer\ContentType\FormUrlencodedContentTypeSerializer;
 use DoclerLabs\ApiClientGenerator\Output\Copy\Serializer\ContentType\JsonContentTypeSerializer;
+use DoclerLabs\ApiClientGenerator\Output\Copy\Serializer\ContentType\VdnApiJsonContentTypeSerializer;
 use DoclerLabs\ApiClientGenerator\Output\Copy\Serializer\ContentType\XmlContentTypeSerializer;
 use DoclerLabs\ApiClientGenerator\Output\Copy\Serializer\QuerySerializer;
 use DoclerLabs\ApiClientGenerator\Output\Php\PhpFileCollection;
@@ -50,6 +50,7 @@ public function generate(Specification $specification, PhpFileCollection $fileRe
             ->addImport(CopiedNamespace::getImport($this->baseNamespace, BodySerializer::class))
             ->addImport(CopiedNamespace::getImport($this->baseNamespace, QuerySerializer::class))
             ->addImport(CopiedNamespace::getImport($this->baseNamespace, JsonContentTypeSerializer::class))
+            ->addImport(CopiedNamespace::getImport($this->baseNamespace, VdnApiJsonContentTypeSerializer::class))
             ->addImport(CopiedNamespace::getImport($this->baseNamespace, FormUrlencodedContentTypeSerializer::class))
             ->addImport(CopiedNamespace::getImport($this->baseNamespace, XmlContentTypeSerializer::class))
             ->addImport(
@@ -219,9 +220,19 @@ private function generateBodySerializerClosure(Specification $specification): Cl
             );
         }
 
+        if (in_array(VdnApiJsonContentTypeSerializer::MIME_TYPE, $allContentTypes, true)) {
+            $vdnApiJsonSerializerInit = $this->builder->methodCall(
+                $xmlSerializerInit ?? $formEncodedSerializerInit ?? $jsonSerializerInit ?? $initialStatement,
+                'add',
+                [
+                    $this->builder->new('VdnApiJsonContentTypeSerializer'),
+                ]
+            );
+        }
+
         $registerBodySerializerClosureStatements[] = $this
             ->builder
-            ->return($xmlSerializerInit ?? $formEncodedSerializerInit ?? $jsonSerializerInit ?? $initialStatement);
+            ->return($vdnApiJsonSerializerInit ?? $xmlSerializerInit ?? $formEncodedSerializerInit ?? $jsonSerializerInit ?? $initialStatement);
 
         return $this->builder->closure(
             $registerBodySerializerClosureStatements,
diff --git a/src/Input/Specification.php b/src/Input/Specification.php
@@ -8,6 +8,7 @@
 use DoclerLabs\ApiClientGenerator\Entity\OperationCollection;
 use DoclerLabs\ApiClientGenerator\Output\Copy\Serializer\ContentType\FormUrlencodedContentTypeSerializer;
 use DoclerLabs\ApiClientGenerator\Output\Copy\Serializer\ContentType\JsonContentTypeSerializer;
+use DoclerLabs\ApiClientGenerator\Output\Copy\Serializer\ContentType\VdnApiJsonContentTypeSerializer;
 use DoclerLabs\ApiClientGenerator\Output\Copy\Serializer\ContentType\XmlContentTypeSerializer;
 
 class Specification
@@ -82,6 +83,7 @@ public function getAllContentTypes(): array
             XmlContentTypeSerializer::MIME_TYPE            => false,
             FormUrlencodedContentTypeSerializer::MIME_TYPE => false,
             JsonContentTypeSerializer::MIME_TYPE           => false,
+            VdnApiJsonContentTypeSerializer::MIME_TYPE     => false,
         ];
 
         /** @var Operation $operation */
diff --git a/src/Output/Copy/Serializer/ContentType/AbstractJsonContentTypeSerializer.php b/src/Output/Copy/Serializer/ContentType/AbstractJsonContentTypeSerializer.php
@@ -0,0 +1,69 @@
+<?php declare(strict_types=1);
+
+namespace DoclerLabs\ApiClientGenerator\Output\Copy\Serializer\ContentType;
+
+use DoclerLabs\ApiClientGenerator\Output\Copy\Schema\SerializableInterface;
+use Psr\Http\Message\StreamInterface;
+
+abstract class AbstractJsonContentTypeSerializer implements ContentTypeSerializerInterface
+{
+    private const JSON_DEPTH = 512;
+    private const JSON_OPTIONS = JSON_BIGINT_AS_STRING | JSON_PRESERVE_ZERO_FRACTION | JSON_UNESCAPED_UNICODE;
+
+    /**
+     * @throws SerializeException
+     */
+    public function encode(SerializableInterface $body): string
+    {
+        $encodedData = json_encode($body->toArray(), self::JSON_OPTIONS);
+
+        $lastErrorCode = json_last_error();
+        if ($lastErrorCode === JSON_ERROR_NONE && $encodedData !== false) {
+            return $encodedData;
+        }
+
+        throw new SerializeException('JSON encode error: ' . $this->getErrorMessage($lastErrorCode));
+    }
+
+    /**
+     * @throws SerializeException
+     */
+    public function decode(StreamInterface $body): array
+    {
+        $body->rewind();
+
+        // According to RFC7159 a JSON value MUST be an object, array, number, string,
+        // or one of the following three literal names: false, null, true.
+        $result = json_decode($body->getContents(), true, self::JSON_DEPTH, self::JSON_OPTIONS);
+
+        $lastErrorCode = json_last_error();
+        if ($lastErrorCode === JSON_ERROR_NONE) {
+            if (!is_array($result)) {
+                $result = [
+                    ContentTypeSerializerInterface::LITERAL_VALUE_KEY => $result,
+                ];
+            }
+
+            return $result;
+        }
+
+        throw new SerializeException('JSON decode error: ' . $this->getErrorMessage($lastErrorCode));
+    }
+
+    private function getErrorMessage(int $errorCode): string
+    {
+        $errorMessages = [
+            JSON_ERROR_NONE             => 'No errors',
+            JSON_ERROR_DEPTH            => 'Maximum stack depth exceeded',
+            JSON_ERROR_STATE_MISMATCH   => 'Underflow or the modes mismatch',
+            JSON_ERROR_CTRL_CHAR        => 'Unexpected control character found',
+            JSON_ERROR_SYNTAX           => 'Syntax error, malformed JSON',
+            JSON_ERROR_UTF8             => 'Malformed UTF-8 characters, possibly incorrectly encoded',
+            JSON_ERROR_RECURSION        => 'Recursive reference was found',
+            JSON_ERROR_INF_OR_NAN       => 'NaN or Inf was found',
+            JSON_ERROR_UNSUPPORTED_TYPE => 'Unsupported type was found',
+        ];
+
+        return $errorMessages[$errorCode] ?? 'Unknown error';
+    }
+}
diff --git a/src/Output/Copy/Serializer/ContentType/JsonContentTypeSerializer.php b/src/Output/Copy/Serializer/ContentType/JsonContentTypeSerializer.php
@@ -2,71 +2,12 @@
 
 namespace DoclerLabs\ApiClientGenerator\Output\Copy\Serializer\ContentType;
 
-use DoclerLabs\ApiClientGenerator\Output\Copy\Schema\SerializableInterface;
-use Psr\Http\Message\StreamInterface;
-
-class JsonContentTypeSerializer implements ContentTypeSerializerInterface
+class JsonContentTypeSerializer extends AbstractJsonContentTypeSerializer
 {
-    const MIME_TYPE = 'application/json';
-    const JSON_DEPTH = 512;
-    const JSON_OPTIONS = JSON_BIGINT_AS_STRING | JSON_PRESERVE_ZERO_FRACTION | JSON_UNESCAPED_UNICODE;
-
-    public function encode(SerializableInterface $body): string
-    {
-        $encodedData = json_encode($body->toArray(), self::JSON_OPTIONS);
-
-        $lastErrorCode = json_last_error();
-        if ($lastErrorCode === JSON_ERROR_NONE && $encodedData !== false) {
-            return $encodedData;
-        }
-
-        throw new SerializeException('JSON encode error: ' . $this->getErrorMessage($lastErrorCode));
-    }
-
-    /**
-     * @throws SerializeException
-     */
-    public function decode(StreamInterface $body): array
-    {
-        $body->rewind();
-
-        // According to RFC7159 a JSON value MUST be an object, array, number, string,
-        // or one of the following three literal names: false, null, true.
-        $result = json_decode($body->getContents(), true, self::JSON_DEPTH, self::JSON_OPTIONS);
-
-        $lastErrorCode = json_last_error();
-        if ($lastErrorCode === JSON_ERROR_NONE) {
-            if (!is_array($result)) {
-                $result = [
-                    ContentTypeSerializerInterface::LITERAL_VALUE_KEY => $result,
-                ];
-            }
-
-            return $result;
-        }
-
-        throw new SerializeException('JSON decode error: ' . $this->getErrorMessage($lastErrorCode));
-    }
+    public const MIME_TYPE = 'application/json';
 
     public function getMimeType(): string
     {
         return self::MIME_TYPE;
     }
-
-    private function getErrorMessage(int $errorCode): string
-    {
-        $errorMessages = [
-            JSON_ERROR_NONE             => 'No errors',
-            JSON_ERROR_DEPTH            => 'Maximum stack depth exceeded',
-            JSON_ERROR_STATE_MISMATCH   => 'Underflow or the modes mismatch',
-            JSON_ERROR_CTRL_CHAR        => 'Unexpected control character found',
-            JSON_ERROR_SYNTAX           => 'Syntax error, malformed JSON',
-            JSON_ERROR_UTF8             => 'Malformed UTF-8 characters, possibly incorrectly encoded',
-            JSON_ERROR_RECURSION        => 'Recursive reference was found',
-            JSON_ERROR_INF_OR_NAN       => 'NaN or Inf was found',
-            JSON_ERROR_UNSUPPORTED_TYPE => 'Unsupported type was found',
-        ];
-
-        return $errorMessages[$errorCode] ?? 'Unknown error';
-    }
 }
diff --git a/src/Output/Copy/Serializer/ContentType/VdnApiJsonContentTypeSerializer.php b/src/Output/Copy/Serializer/ContentType/VdnApiJsonContentTypeSerializer.php
@@ -0,0 +1,13 @@
+<?php declare(strict_types=1);
+
+namespace DoclerLabs\ApiClientGenerator\Output\Copy\Serializer\ContentType;
+
+class VdnApiJsonContentTypeSerializer extends AbstractJsonContentTypeSerializer
+{
+    public const MIME_TYPE = 'application/vnd.api+json';
+
+    public function getMimeType(): string
+    {
+        return self::MIME_TYPE;
+    }
+}
diff --git a/test/suite/functional/Generator/ServiceProvider/ServiceProviderPhp70.php b/test/suite/functional/Generator/ServiceProvider/ServiceProviderPhp70.php
diff --git a/test/suite/functional/Generator/ServiceProvider/ServiceProviderPhp72.php b/test/suite/functional/Generator/ServiceProvider/ServiceProviderPhp72.php
diff --git a/test/suite/functional/Generator/ServiceProvider/petstore.yaml b/test/suite/functional/Generator/ServiceProvider/petstore.yaml
diff --git a/test/suite/functional/Output/Copy/Serializer/BodySerializerTest.php b/test/suite/functional/Output/Copy/Serializer/BodySerializerTest.php
diff --git a/test/suite/unit/Output/Copy/Serializer/ContentType/VdnApiJsonContentTypeSerializerTest.php b/test/suite/unit/Output/Copy/Serializer/ContentType/VdnApiJsonContentTypeSerializerTest.php
