Allow to pass processors configuration to swagger-php

DarkaOnLine · Aug 28, 2024 · 84639e8 · 84639e8
1 parent 44bab24
commit 84639e8
Show file tree

Hide file tree

Showing 3 changed files with 28 additions and 0 deletions.
diff --git a/config/l5-swagger.php b/config/l5-swagger.php
@@ -102,6 +102,24 @@
         ],
 
         'scanOptions' => [
+            /**
+             * Configuration for default processors. Allows to pass processors configuration to swagger-php
+             *
+             * @link https://zircote.github.io/swagger-php/reference/processors.html
+             */
+            'default_processors_configuration' => [
+                /** Example */
+                /**
+                'operationId.hash' => true,
+                'pathFilter' => [
+                    'tags' => [
+                        '/pets/',
+                        '/store/',
+                    ],
+                ],
+                */
+            ],
+
             /**
              * analyser: defaults to \OpenApi\StaticAnalyser .
              *

diff --git a/src/Generator.php b/src/Generator.php
@@ -202,6 +202,15 @@ protected function createOpenApiGenerator(): OpenApiGenerator
     {
         $generator = new OpenApiGenerator();
 
+        // Only from zircote/swagger-php 4
+        if (
+            !empty($this->scanOptions['default_processors_configuration'])
+            && is_array($this->scanOptions['default_processors_configuration'])
+            && method_exists($generator, 'setConfig')
+        ) {
+            $generator->setConfig($this->scanOptions['default_processors_configuration']);
+        }
+
         // OpenApi spec version - only from zircote/swagger-php 4
         if (method_exists($generator, 'setVersion')) {
             $generator->setVersion(

diff --git a/src/L5SwaggerServiceProvider.php b/src/L5SwaggerServiceProvider.php
@@ -52,6 +52,7 @@ public function register()
         $this->app->bind(Generator::class, function ($app) {
             $documentation = config('l5-swagger.default');
 
+            /** @var GeneratorFactory $factory */
             $factory = $app->make(GeneratorFactory::class);
 
             return $factory->make($documentation);