Merge pull request #410 from Potelo/master

Use a file payload as response

Author: shalvah

src/Tools/ResponseResolver.php

@@ -5,13 +5,15 @@
 use Illuminate\Routing\Route;
 use Mpociot\ApiDoc\Tools\ResponseStrategies\ResponseTagStrategy;
 use Mpociot\ApiDoc\Tools\ResponseStrategies\ResponseCallStrategy;
+use Mpociot\ApiDoc\Tools\ResponseStrategies\ResponseFileStrategy;
 use Mpociot\ApiDoc\Tools\ResponseStrategies\TransformerTagsStrategy;
 
 class ResponseResolver
 {
     public static $strategies = [
         ResponseTagStrategy::class,
         TransformerTagsStrategy::class,
+        ResponseFileStrategy::class,
         ResponseCallStrategy::class,
     ];
 

src/Tools/ResponseStrategies/ResponseFileStrategy.php

@@ -0,0 +1,39 @@
+<?php
+
+namespace Mpociot\ApiDoc\Tools\ResponseStrategies;
+
+use Illuminate\Routing\Route;
+use Mpociot\Reflection\DocBlock\Tag;
+
+/**
+ * Get a response from from a file in the docblock ( @responseFile ).
+ */
+class ResponseFileStrategy
+{
+    public function __invoke(Route $route, array $tags, array $routeProps)
+    {
+        return $this->getFileResponse($tags);
+    }
+
+    /**
+     * Get the response from the file if available.
+     *
+     * @param array $tags
+     *
+     * @return mixed
+     */
+    protected function getFileResponse(array $tags)
+    {
+        $responseFileTags = array_filter($tags, function ($tag) {
+            return $tag instanceof Tag && strtolower($tag->getName()) == 'responsefile';
+        });
+        if (empty($responseFileTags)) {
+            return;
+        }
+        $responseFileTag = array_first($responseFileTags);
+
+        $json = json_decode(file_get_contents(storage_path($responseFileTag->getContent()), true), true);
+
+        return response()->json($json);
+    }
+}

tests/Fixtures/TestController.php

@@ -163,4 +163,12 @@ public function transformerCollectionTagWithModel()
     {
         return '';
     }
+
+    /**
+     * @responseFile response_test.json
+     */
+    public function responseFileTag()
+    {
+        return '';
+    }
 }

tests/Fixtures/response_test.json

@@ -0,0 +1 @@
+{"id":5,"name":"Jessica Jones","gender":"female"}

tests/Unit/GeneratorTestCase.php

@@ -4,6 +4,7 @@
 
 use Orchestra\Testbench\TestCase;
 use Mpociot\ApiDoc\Tools\Generator;
+use Illuminate\Support\Facades\Storage;
 use Mpociot\ApiDoc\ApiDocGeneratorServiceProvider;
 
 abstract class GeneratorTestCase extends TestCase
@@ -265,6 +266,27 @@ public function can_call_route_and_generate_response()
         ], json_decode($parsed['response'], true));
     }
 
+    /** @test */
+    public function can_parse_response_file_tag()
+    {
+        // copy file to storage
+        $filePath = __DIR__.'/../Fixtures/response_test.json';
+        $fixtureFileJson = file_get_contents($filePath);
+        copy($filePath, storage_path('response_test.json'));
+
+        $route = $this->createRoute('GET', '/responseFileTag', 'responseFileTag');
+        $parsed = $this->generator->processRoute($route);
+        $this->assertTrue(is_array($parsed));
+        $this->assertArrayHasKey('showresponse', $parsed);
+        $this->assertTrue($parsed['showresponse']);
+        $this->assertSame(
+            $parsed['response'],
+            $fixtureFileJson
+        );
+
+        unlink(storage_path('response_test.json'));
+    }
+
     /** @test */
     public function uses_configured_settings_when_calling_route()
     {