Merge pull request #134 from szhajdu/RFC-6839

tommey · web-flow · commit 709826efb3e4 · 2026-02-23T12:28:52.000+01:00
feat: RFC 6839 support #133
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).
 
+## [11.2.0] - 2026-02-19
+### Added
+- RFC 6839 support: Content types with `+json` suffix (e.g., `application/vnd.api+json`, `application/hal+json`, `application/problem+json`) are now recognized as JSON-based formats
+
 ## [11.1.3] - 2025.12.08
 ### Fixed
 - Fixed content type construction parameter generation - issue #128, fixed
diff --git a/README.md b/README.md
@@ -27,6 +27,7 @@ API client generator is a console application capable of auto-generating a [PSR1
     * application/json
     * application/x-www-form-urlencoded
     * application/xml
+    * Any content type with `+json` suffix ([RFC 6839](https://datatracker.ietf.org/doc/html/rfc6839)), e.g., `application/hal+json`, `application/problem+json`, `application/vnd.sdmx.data+json`
 - Supports new PHP versions syntax features.
 - It is base client independent, you are free to choose any [existing PSR-18 compliant client](https://packagist.org/providers/psr/http-client-implementation). Just choose the one which you already use, so generated client would not cause any conflicts with your dependencies. Although not recommended, you can also use or build your own PSR-18 implementation, as the generated client depends on PSR interfaces only.
 - Applies code style rules to generated code, you can specify your own.
diff --git a/src/Command/GenerateCommand.php b/src/Command/GenerateCommand.php
@@ -5,6 +5,7 @@
 namespace DoclerLabs\ApiClientGenerator\Command;
 
 use DoclerLabs\ApiClientGenerator\CodeGeneratorFacade;
+use DoclerLabs\ApiClientGenerator\Entity\ContentType;
 use DoclerLabs\ApiClientGenerator\Generator\Security\BasicAuthenticationSecurityStrategy;
 use DoclerLabs\ApiClientGenerator\Input\Configuration;
 use DoclerLabs\ApiClientGenerator\Input\FileReader;
@@ -253,22 +254,33 @@ static function (): bool {
 
     private function getUnusedSerializers(Specification $specification): array
     {
-        $contentTypeMapping = [
-            XmlContentTypeSerializer::MIME_TYPE            => XmlContentTypeSerializer::class,
-            FormUrlencodedContentTypeSerializer::MIME_TYPE => FormUrlencodedContentTypeSerializer::class,
-            JsonContentTypeSerializer::MIME_TYPE           => JsonContentTypeSerializer::class,
-            VdnApiJsonContentTypeSerializer::MIME_TYPE     => VdnApiJsonContentTypeSerializer::class,
-        ];
-
-        $allContentTypes = $specification->getAllContentTypes();
-
-        return array_values(
-            array_filter(
-                $contentTypeMapping,
-                static fn (string $key) => !in_array($key, $allContentTypes, true),
-                ARRAY_FILTER_USE_KEY
-            )
+        $allContentTypes   = $specification->getAllContentTypes();
+        $unusedSerializers = [];
+
+        // JSON serializer is needed if any JSON-based content type is used (RFC 6839)
+        $needsJsonSerializer = array_reduce(
+            $allContentTypes,
+            static fn (bool $carry, string $ct): bool => $carry || ContentType::isJsonBased($ct),
+            false
         );
+
+        if (!$needsJsonSerializer) {
+            $unusedSerializers[] = JsonContentTypeSerializer::class;
+        }
+
+        if (!in_array(VdnApiJsonContentTypeSerializer::MIME_TYPE, $allContentTypes, true)) {
+            $unusedSerializers[] = VdnApiJsonContentTypeSerializer::class;
+        }
+
+        if (!in_array(FormUrlencodedContentTypeSerializer::MIME_TYPE, $allContentTypes, true)) {
+            $unusedSerializers[] = FormUrlencodedContentTypeSerializer::class;
+        }
+
+        if (!in_array(XmlContentTypeSerializer::MIME_TYPE, $allContentTypes, true)) {
+            $unusedSerializers[] = XmlContentTypeSerializer::class;
+        }
+
+        return $unusedSerializers;
     }
 
     /**
diff --git a/src/Entity/ContentType.php b/src/Entity/ContentType.php
@@ -0,0 +1,80 @@
+<?php
+
+declare(strict_types=1);
+
+namespace DoclerLabs\ApiClientGenerator\Entity;
+
+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;
+
+final class ContentType
+{
+    private const ALLOWED_CONTENT_TYPES = [
+        JsonContentTypeSerializer::MIME_TYPE,
+        FormUrlencodedContentTypeSerializer::MIME_TYPE,
+        XmlContentTypeSerializer::MIME_TYPE,
+        VdnApiJsonContentTypeSerializer::MIME_TYPE,
+    ];
+
+    private const JSON_SUFFIX = '+json';
+
+    /**
+     * Checks if a content type is supported by the generator.
+     *
+     * Supports:
+     * - Standard content types (application/json, application/xml, etc.)
+     * - RFC 6839 structured syntax suffixes (+json indicates JSON format)
+     * - Content types with parameters (charset, version, etc.)
+     */
+    public static function isSupported(string $contentType): bool
+    {
+        $normalizedContentType = self::normalize($contentType);
+
+        if (in_array($normalizedContentType, self::ALLOWED_CONTENT_TYPES, true)) {
+            return true;
+        }
+
+        // RFC 6839: +json suffix indicates JSON-based format
+        return str_ends_with($normalizedContentType, self::JSON_SUFFIX);
+    }
+
+    /**
+     * Normalizes a content type by removing parameters and converting to lowercase.
+     *
+     * Example: "Application/JSON; charset=utf-8" becomes "application/json"
+     */
+    public static function normalize(string $contentType): string
+    {
+        return strtolower(trim(explode(';', $contentType)[0]));
+    }
+
+    /**
+     * Checks if a content type is JSON-based (either standard or +json suffix).
+     */
+    public static function isJsonBased(string $contentType): bool
+    {
+        $normalizedContentType = self::normalize($contentType);
+
+        return $normalizedContentType === JsonContentTypeSerializer::MIME_TYPE
+               || str_ends_with($normalizedContentType, self::JSON_SUFFIX);
+    }
+
+    /**
+     * Filters an array of content types and returns only unsupported ones.
+     *
+     * @param string[] $contentTypes
+     *
+     * @return string[]
+     */
+    public static function filterUnsupported(array $contentTypes): array
+    {
+        return array_values(
+            array_filter(
+                $contentTypes,
+                static fn (string $contentType): bool => !self::isSupported($contentType)
+            )
+        );
+    }
+}
diff --git a/src/Entity/Request.php b/src/Entity/Request.php
@@ -5,10 +5,6 @@
 namespace DoclerLabs\ApiClientGenerator\Entity;
 
 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
 {
@@ -36,13 +32,6 @@ class Request
         self::HEAD,
     ];
 
-    private const ALLOWED_CONTENT_TYPES = [
-        JsonContentTypeSerializer::MIME_TYPE,
-        FormUrlencodedContentTypeSerializer::MIME_TYPE,
-        XmlContentTypeSerializer::MIME_TYPE,
-        VdnApiJsonContentTypeSerializer::MIME_TYPE,
-    ];
-
     public function __construct(
         public readonly string $path,
         public readonly string $method,
@@ -55,7 +44,8 @@ public function __construct(
             );
         }
 
-        $unsupportedContentTypes = array_diff($bodyContentTypes, Request::ALLOWED_CONTENT_TYPES);
+        $unsupportedContentTypes = ContentType::filterUnsupported($bodyContentTypes);
+
         if (!empty($unsupportedContentTypes)) {
             throw new InvalidSpecificationException(
                 sprintf('Request content-type %s is not currently supported.', json_encode($unsupportedContentTypes))
diff --git a/src/Entity/Response.php b/src/Entity/Response.php
@@ -5,26 +5,16 @@
 namespace DoclerLabs\ApiClientGenerator\Entity;
 
 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 Response
 {
-    private const ALLOWED_CONTENT_TYPES = [
-        JsonContentTypeSerializer::MIME_TYPE,
-        FormUrlencodedContentTypeSerializer::MIME_TYPE,
-        XmlContentTypeSerializer::MIME_TYPE,
-        VdnApiJsonContentTypeSerializer::MIME_TYPE,
-    ];
-
     public function __construct(
         public readonly int $statusCode,
         public readonly ?Field $body = null,
         public readonly array $bodyContentTypes = []
     ) {
-        $unsupportedContentTypes = array_diff($bodyContentTypes, self::ALLOWED_CONTENT_TYPES);
+        $unsupportedContentTypes = ContentType::filterUnsupported($bodyContentTypes);
+
         if (!empty($unsupportedContentTypes)) {
             throw new InvalidSpecificationException(
                 sprintf('Response content-type %s is not currently supported.', json_encode($unsupportedContentTypes))
diff --git a/src/Generator/ServiceProviderGenerator.php b/src/Generator/ServiceProviderGenerator.php
@@ -8,6 +8,7 @@
 use DoclerLabs\ApiClientGenerator\Ast\Builder\CodeBuilder;
 use DoclerLabs\ApiClientGenerator\Ast\Builder\MethodBuilder;
 use DoclerLabs\ApiClientGenerator\Ast\PhpVersion;
+use DoclerLabs\ApiClientGenerator\Entity\ContentType;
 use DoclerLabs\ApiClientGenerator\Entity\Field;
 use DoclerLabs\ApiClientGenerator\Generator\Implementation\ContainerImplementationStrategy;
 use DoclerLabs\ApiClientGenerator\Generator\Implementation\HttpMessageImplementationStrategy;
@@ -192,7 +193,14 @@ private function generateBodySerializerClosure(Specification $specification): Cl
         $serializer      = $this->builder->new('BodySerializer');
         $allContentTypes = $specification->getAllContentTypes();
 
-        if (in_array(JsonContentTypeSerializer::MIME_TYPE, $allContentTypes, true)) {
+        // Register JSON serializer if any JSON-based content type is used (RFC 6839)
+        $needsJsonSerializer = array_reduce(
+            $allContentTypes,
+            static fn (bool $carry, string $ct): bool => $carry || ContentType::isJsonBased($ct),
+            false
+        );
+
+        if ($needsJsonSerializer) {
             $serializer = $this->builder->methodCall(
                 $serializer,
                 'add',
diff --git a/src/Output/Copy/Serializer/BodySerializer.php b/src/Output/Copy/Serializer/BodySerializer.php
@@ -8,12 +8,15 @@
 use DoclerLabs\ApiClientException\UnexpectedResponseException;
 use DoclerLabs\ApiClientGenerator\Output\Copy\Request\RequestInterface;
 use DoclerLabs\ApiClientGenerator\Output\Copy\Serializer\ContentType\ContentTypeSerializerInterface;
+use DoclerLabs\ApiClientGenerator\Output\Copy\Serializer\ContentType\JsonContentTypeSerializer;
 use InvalidArgumentException;
 use Psr\Http\Message\ResponseInterface;
 use Throwable;
 
 class BodySerializer
 {
+    private const JSON_SUFFIX = '+json';
+
     /** @var ContentTypeSerializerInterface[] */
     private $contentTypeSerializers = [];
 
@@ -60,18 +63,39 @@ public function unserializeResponse(ResponseInterface $response): array
 
     private function getContentTypeSerializer(string $contentType): ContentTypeSerializerInterface
     {
-        $contentType = strtolower(trim(explode(';', $contentType)[0]));
-
-        if (!isset($this->contentTypeSerializers[$contentType])) {
-            throw new InvalidArgumentException(
-                sprintf(
-                    'Serializer for `%s` is not found. Supported: %s',
-                    $contentType,
-                    json_encode(array_keys($this->contentTypeSerializers))
-                )
-            );
+        $normalizedContentType = $this->normalizeContentType($contentType);
+
+        if (isset($this->contentTypeSerializers[$normalizedContentType])) {
+            return $this->contentTypeSerializers[$normalizedContentType];
+        }
+
+        // RFC 6839: +json suffix indicates JSON-based format, fall back to JSON serializer
+        if ($this->isJsonBasedContentType($normalizedContentType)) {
+            return $this->contentTypeSerializers[JsonContentTypeSerializer::MIME_TYPE];
         }
 
-        return $this->contentTypeSerializers[$contentType];
+        throw new InvalidArgumentException(
+            sprintf(
+                'Serializer for `%s` is not found. Supported: %s',
+                $normalizedContentType,
+                json_encode(array_keys($this->contentTypeSerializers))
+            )
+        );
+    }
+
+    private function normalizeContentType(string $contentType): string
+    {
+        return strtolower(trim(explode(';', $contentType)[0]));
+    }
+
+    private function isJsonBasedContentType(string $normalizedContentType): bool
+    {
+        return $this->endsWith($normalizedContentType, self::JSON_SUFFIX)
+            && isset($this->contentTypeSerializers[JsonContentTypeSerializer::MIME_TYPE]);
+    }
+
+    private function endsWith(string $haystack, string $needle): bool
+    {
+        return $needle === '' || substr($haystack, -strlen($needle)) === $needle;
     }
 }
diff --git a/test/suite/unit/Entity/ContentTypeTest.php b/test/suite/unit/Entity/ContentTypeTest.php
diff --git a/test/suite/unit/Entity/RequestTest.php b/test/suite/unit/Entity/RequestTest.php
diff --git a/test/suite/unit/Entity/ResponseTest.php b/test/suite/unit/Entity/ResponseTest.php
diff --git a/test/suite/unit/Output/Copy/Serializer/BodySerializerTest.php b/test/suite/unit/Output/Copy/Serializer/BodySerializerTest.php
