IBX-10396: Added support for x-ibexa-example-file in request files

src/bundle/ApiPlatform/OpenApiFactory.php

@@ -11,6 +11,7 @@
 use ApiPlatform\OpenApi\Factory\OpenApiFactoryInterface;
 use ApiPlatform\OpenApi\Model\Info;
 use ApiPlatform\OpenApi\Model\Operation;
+use ApiPlatform\OpenApi\Model\RequestBody;
 use ApiPlatform\OpenApi\Model\Response;
 use ApiPlatform\OpenApi\Model\Server;
 use ApiPlatform\OpenApi\OpenApi;
@@ -101,6 +102,7 @@
     private function processOperations(Operation $operation): Operation
     {
         $newOperation = $operation;
+        $newOperation = $this->insertIbexaRequestExample($newOperation);
         $newOperation = $this->insertIbexaResponseExample($newOperation);
 
         return $this->insertIbexaEditionBadges($newOperation);
@@ -120,6 +122,54 @@
         return $operation;
     }
 
+    private function insertIbexaRequestExample(Operation $operation): Operation
+    {
+        $requestBody = $operation->getRequestBody();
+
+        if ($requestBody === null) {
+            return $operation;
+        }
+
+        $content = $requestBody->getContent();
+
+        if ($content === null) {
+            return $operation;
+        }
+
+        /** @var ArrayObject<string, mixed> $newContent */
+        $newContent = new ArrayObject();
+        $hasChanges = false;
+
+        foreach ($content as $mediaType => $requestContent) {
+            if (!array_key_exists('x-ibexa-example-file', $requestContent)) {
+                $newContent[$mediaType] = $requestContent;
+                continue;
+            }
+
+            $exampleFilePath = $this->kernel->locateResource($requestContent['x-ibexa-example-file']);
+            $example = $this->loadExampleFromFile($exampleFilePath);
+
+            $newRequestContent = $requestContent;
+            $newRequestContent['example'] = $example;
+            unset($newRequestContent['x-ibexa-example-file']);
+
+            $newContent[$mediaType] = $newRequestContent;
+            $hasChanges = true;
+        }
+
+        if ($hasChanges === true) {
+            $newRequestBody = new RequestBody(
+                $requestBody->getDescription(),
+                $newContent,
+                $requestBody->getRequired()
+            );
+
+            return $operation->withRequestBody($newRequestBody);
+        }
+
+        return $operation;
+    }
+
     /**
      * @throws \JsonException
      */
@@ -140,9 +190,8 @@
                 }
 
                 $exampleFilePath = $this->kernel->locateResource($responseContent['x-ibexa-example-file']);
-                $exampleFileContent = file_get_contents($exampleFilePath);
-                $isJson = 'json' === array_slice(explode('.', pathinfo($exampleFilePath, PATHINFO_FILENAME)), -1, 1)[0];
-                $newContent[$mediaType]['example'] = $isJson ? json_decode($exampleFileContent ?: '', true, 512, JSON_THROW_ON_ERROR) : $exampleFileContent;
+                $example = $this->loadExampleFromFile($exampleFilePath);
+                $newContent[$mediaType]['example'] = $example;
                 unset($newContent[$mediaType]['x-ibexa-example-file']);
             }
 
@@ -156,4 +205,39 @@
 
         return $newOperation;
     }
+
+    /**
+     * @return array<string, mixed>|string
+     *
+     * @throws \JsonException
+     */
+    private function loadExampleFromFile(string $filePath): array|string
+    {
+        $fileContent = file_get_contents($filePath);
+
+        if ($fileContent === false) {
+            throw new \RuntimeException("Failed to read example file: {$filePath}");
+        }
+
+        return $this->isJson($filePath)
+            ? $this->parseJsonFile($fileContent, $filePath)
+            : $fileContent;
+    }
+
+    private function isJson(string $filePath): bool
+    {
+        return in_array('json', explode('.', pathinfo($filePath, PATHINFO_FILENAME)));
+    }
+
+    /**
+     * @return array<string, mixed>
+     */
+    private function parseJsonFile(string $fileContent, string $filePath): array
+    {
+        try {
+            return json_decode($fileContent, true, 512, JSON_THROW_ON_ERROR);
+        } catch (\JsonException $e) {
+            throw new \RuntimeException("Failed to parse JSON example file: {$filePath}", 0, $e);
+        }
+    }
 }

tests/bundle/ApiPlatform/Fixtures/examples/test-request.json.example

@@ -0,0 +1,4 @@
+{
+    "username": "admin",
+    "password": "secret"
+}

tests/bundle/ApiPlatform/Fixtures/examples/test-request.xml.example

@@ -0,0 +1,5 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<LoginRequest>
+    <username>admin</username>
+    <password>secret</password>
+</LoginRequest>

tests/bundle/ApiPlatform/Fixtures/examples/test-response.json.example

@@ -0,0 +1,7 @@
+{
+    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9",
+    "user": {
+        "id": 14,
+        "login": "admin"
+    }
+}

tests/bundle/ApiPlatform/Fixtures/examples/test-response.xml.example

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<Session>
+    <identifier>go327ij2cirpo59pb6rrv2a4el2</identifier>
+    <name>eZSESSID</name>
+    <csrfToken>23lkneri34ijajedfw39orj3j93</csrfToken>
+</Session>