Improving ApiRequest and ApiClient support for custom serialization formats and additional headers.

Author: VincentChalnot

Client/ApiClient.php

@@ -46,31 +46,34 @@ protected function deserialize(ApiRequestInterface $apiRequest, ?string $normali
             return $this->serializer->deserialize(
                 $normalizedData,
                 $apiRequest->getClassName(),
-                'json',
+                $apiRequest->getDeserializationFormat(),
                 $apiRequest->getDeserializationContext()
             );
         } catch (\Exception $e) {
             throw $this->handleError(
                 $e,
+                $apiRequest,
                 $normalizedData,
-                $apiRequest->getClassName(),
-                $apiRequest->getDeserializationContext()
             );
         }
     }
 
     protected function getRequest(ApiRequestInterface $apiRequest): RequestInterface
     {
         $request = $this->requestFactory->createRequest($apiRequest->getMethod(), $apiRequest->getPath())
-            ->withHeader('Content-Type', 'application/json');
+            ->withHeader('Content-Type', $apiRequest->getContentType());
+
+        foreach ($apiRequest->getHeaders() as $header => $value) {
+            $request = $request->withHeader($header, $value);
+        }
 
         if (null === $apiRequest->getContent()) {
             return $request;
         }
 
         $serializedContent = $this->serializer->serialize(
             $apiRequest->getContent(),
-            'json',
+            $apiRequest->getSerializationFormat(),
             $apiRequest->getSerializationContext()
         );
 
@@ -113,18 +116,17 @@ protected function getResponseData(
 
     protected function handleError(
         \Exception $exception,
+        ApiRequestInterface $apiRequest,
         string $normalizedData,
-        string $className,
-        array $deserializationContext
     ): ApiDeserializationException {
         $errorClass = $deserializationContext['error_class'] ?? null;
         if ($errorClass) {
             try {
                 $errorObject = $this->serializer->deserialize(
                     $normalizedData,
                     $errorClass,
-                    'json',
-                    $deserializationContext
+                    $apiRequest->getDeserializationFormat(),
+                    $apiRequest->getDeserializationContext(),
                 );
             } catch (\Exception) {
                 $errorObject = \json_decode($normalizedData, true, 512, JSON_THROW_ON_ERROR);
@@ -133,6 +135,11 @@ protected function handleError(
             $errorObject = \json_decode($normalizedData, true, 512, JSON_THROW_ON_ERROR);
         }
 
-        return ApiDeserializationException::create($exception, $normalizedData, $className, $errorObject);
+        return ApiDeserializationException::create(
+            $exception,
+            $normalizedData,
+            $apiRequest->getClassName(),
+            $errorObject
+        );
     }
 }

Request/ApiRequest.php

@@ -16,8 +16,16 @@ class ApiRequest implements ApiRequestInterface
 
     protected mixed $content;
 
+    protected string $contentType = 'application/json';
+
+    protected array $headers = [];
+
+    protected string $serializationFormat = 'json';
+
     protected array $serializationContext = [];
 
+    protected string $deserializationFormat = 'json';
+
     protected array $deserializationContext = [];
 
     public function __construct(
@@ -46,11 +54,31 @@ public function getContent(): mixed
         return $this->content;
     }
 
+    public function getContentType(): string
+    {
+        return $this->contentType;
+    }
+
+    public function getHeaders(): array
+    {
+        return $this->headers;
+    }
+
+    public function getSerializationFormat(): string
+    {
+        return $this->serializationFormat;
+    }
+
     public function getSerializationContext(): array
     {
         return $this->serializationContext;
     }
 
+    public function getDeserializationFormat(): string
+    {
+        return $this->deserializationFormat;
+    }
+
     public function getDeserializationContext(): array
     {
         return $this->deserializationContext;
@@ -70,13 +98,55 @@ public function setContent(mixed $content): self
         return $this;
     }
 
+    public function setContentType(string $contentType): self
+    {
+        $this->contentType = $contentType;
+
+        return $this;
+    }
+
+    public function setHeaders(array $headers): self
+    {
+        $this->headers = $headers;
+
+        return $this;
+    }
+
+    public function addHeader(string $key, string $value): self
+    {
+        $this->headers[$key] = $value;
+
+        return $this;
+    }
+
+    public function removeHeader(string $key): self
+    {
+        unset($this->headers[$key]);
+
+        return $this;
+    }
+
+    public function setSerializationFormat(string $serializationFormat): self
+    {
+        $this->serializationFormat = $serializationFormat;
+
+        return $this;
+    }
+
     public function setSerializationContext(array $serializationContext): self
     {
         $this->serializationContext = $serializationContext;
 
         return $this;
     }
 
+    public function setDeserializationFormat(string $deserializationFormat): self
+    {
+        $this->deserializationFormat = $deserializationFormat;
+
+        return $this;
+    }
+
     public function setDeserializationContext(array $deserializationContext): self
     {
         $this->deserializationContext = $deserializationContext;

Request/ApiRequestInterface.php

@@ -18,9 +18,17 @@ public function getPath(): string;
 
     public function getClassName(): string;
 
-    public function getContent();
+    public function getContent(): mixed;
+
+    public function getContentType(): string;
+
+    public function getHeaders(): array;
+
+    public function getSerializationFormat(): string;
 
     public function getSerializationContext(): array;
 
+    public function getDeserializationFormat(): string;
+
     public function getDeserializationContext(): array;
 }