Allow customising swagger responses

composer.json

@@ -9,7 +9,7 @@
         }
     ],
     "require-dev": {
-        "php": ">=7.0",
+        "php": ">=7.1",
         "orchestra/testbench": "~4.0",
         "phpunit/phpunit": "^8.0|^9.0",
         "laravel/passport": "^8.0"

src/GenerateSwaggerDoc.php

@@ -6,6 +6,14 @@
 
 class GenerateSwaggerDoc extends Command
 {
+    protected $responseGenerator;
+
+    public function __construct(Responses\ResponseGeneratorInterface $responseGenerator = null)
+    {
+        parent::__construct();
+        $this->responseGenerator = $responseGenerator;
+    }
+
     /**
      * The name and signature of the console command.
      *
@@ -34,7 +42,7 @@ public function handle()
         $filter = $this->option('filter') ?: null;
         $file = $this->option('output') ?: null;
 
-        $docs = (new Generator($config, $filter))->generate();
+        $docs = (new Generator($config, $filter, $this->responseGenerator))->generate();
 
         $formattedDocs = (new FormatterManager($docs))
             ->setFormat($this->option('format'))

src/Generator.php

@@ -15,16 +15,18 @@ class Generator
 
     protected $config;
     protected $routeFilter;
+    protected $responseGenerator;
     protected $docs;
     protected $route;
     protected $method;
     protected $docParser;
     protected $hasSecurityDefinitions;
 
-    public function __construct($config, $routeFilter = null)
+    public function __construct($config, $routeFilter = null, Responses\ResponseGeneratorInterface $responseGenerator = null)
     {
         $this->config = $config;
         $this->routeFilter = $routeFilter;
+        $this->responseGenerator = $responseGenerator ?: new Responses\ResponseGenerator();
         $this->docParser = DocBlockFactory::createInstance();
         $this->hasSecurityDefinitions = false;
     }
@@ -137,20 +139,23 @@ protected function generatePath()
             'summary' => $summary,
             'description' => $description,
             'deprecated' => $isDeprecated,
-            'responses' => [
-                '200' => [
-                    'description' => 'OK',
-                ],
-            ],
         ];
 
+        $this->addResponseDefinition();
         $this->addActionParameters();
 
         if ($this->hasSecurityDefinitions) {
             $this->addActionScopes();
         }
     }
 
+    protected function addResponseDefinition()
+    {
+        $actionInstance = $this->getActionClassInstance();
+        $responses = $this->responseGenerator->getResponses($this->route->uri(), $this->method, $actionInstance);
+        $this->docs['paths'][$this->route->uri()][$this->method]['responses'] = $responses;
+    }
+
     protected function addActionParameters()
     {
         $rules = $this->getFormRules() ?: [];

src/Responses/ResponseGenerator.php

@@ -0,0 +1,18 @@
+<?php
+
+namespace Mtrajano\LaravelSwagger\Responses;
+
+class ResponseGenerator implements ResponseGeneratorInterface
+{
+    /**
+     * @inheritDoc
+     */
+    public function getResponses($uri, $method, $actionInstance)
+    {
+        return [
+            '200' => [
+                'description' => 'OK',
+            ],
+        ];
+    }
+}

src/Responses/ResponseGeneratorInterface.php

@@ -0,0 +1,14 @@
+<?php
+
+namespace Mtrajano\LaravelSwagger\Responses;
+
+interface ResponseGeneratorInterface
+{
+    /**
+     * @param string $uri
+     * @param string $method
+     * @param ?\ReflectionMethod $actionInstance
+     * @return array
+     */
+    public function getResponses($uri, $method, $actionInstance);
+}

tests/GeneratorTest.php

@@ -2,15 +2,19 @@
 
 namespace Mtrajano\LaravelSwagger\Tests;
 
+use Illuminate\Contracts\Container\BindingResolutionException;
 use Mtrajano\LaravelSwagger\Generator;
 use Mtrajano\LaravelSwagger\LaravelSwaggerException;
+use Mtrajano\LaravelSwagger\Responses\ResponseGeneratorInterface;
 
 class GeneratorTest extends TestCase
 {
     protected $config;
 
     protected $generator;
 
+    protected $responseGenerator;
+
     protected $endpoints = [
         '/users',
         '/users/{id}',
@@ -34,8 +38,16 @@ public function setUp(): void
     {
         parent::setUp();
 
+        try {
+            $this->responseGenerator = $this->app->make(ResponseGeneratorInterface::class);
+        } catch (BindingResolutionException $e) {
+            $this->responseGenerator = null;
+        }
+
         $this->generator = new Generator(
-            $this->config = config('laravel-swagger')
+            $this->config = config('laravel-swagger'),
+            null,
+            $this->responseGenerator
         );
     }
 
@@ -197,6 +209,9 @@ public function testRouteData($paths)
 Please read the documentation for more information
 EOD;
 
+        //Allow running tests on windows
+        $expectedPostDescription = str_replace(PHP_EOL, "\n", $expectedPostDescription);
+
         $this->assertArrayHasKey('summary', $paths['/users']['get']);
         $this->assertArrayHasKey('description', $paths['/users']['get']);
         $this->assertArrayHasKey('responses', $paths['/users']['get']);
@@ -282,7 +297,8 @@ public function testFiltersRoutes($routeFilter, $expectedRoutes)
     {
         $this->generator = new Generator(
             $this->config,
-            $routeFilter
+            $routeFilter,
+            $this->responseGenerator
         );
 
         $docs = $this->generator->generate();
@@ -306,6 +322,6 @@ private function getDocsWithNewConfig(array $config)
     {
         $config = array_merge($this->config, $config);
 
-        return (new Generator($config))->generate();
+        return (new Generator($config, null, $this->responseGenerator))->generate();
     }
 }