Add custom paths to the configuration file.

Author: marttosc

config/openapi.php

@@ -7,9 +7,9 @@
         'default' => [
 
             'info' => [
-                'title' => config('app.name'),
+                'title'       => config('app.name'),
                 'description' => null,
-                'version' => '1.0.0',
+                'version'     => '1.0.0',
             ],
 
             'servers' => [
@@ -27,14 +27,14 @@
 
             ],
 
-            'security' => [
+            'security'    => [
                 // GoldSpecDigital\ObjectOrientedOAS\Objects\SecurityRequirement::create()->securityScheme('JWT'),
             ],
 
             // Route for exposing specification.
             // Leave uri null to disable.
-            'route' => [
-                'uri' => '/openapi',
+            'route'       => [
+                'uri'        => '/openapi',
                 'middleware' => [],
             ],
 
@@ -49,4 +49,26 @@
 
     ],
 
+    'paths' => [
+        'callbacks' => [
+            //
+        ],
+
+        'request_bodies' => [
+            //
+        ],
+
+        'responses' => [
+            //
+        ],
+
+        'schemas' => [
+            //
+        ],
+
+        'security_schemes' => [
+            //
+        ],
+    ],
+
 ];

src/OpenApiServiceProvider.php

@@ -5,6 +5,7 @@
 namespace Vyuldashev\LaravelOpenApi;
 
 use Doctrine\Common\Annotations\AnnotationRegistry;
+use Illuminate\Support\Collection;
 use Illuminate\Support\ServiceProvider;
 use Vyuldashev\LaravelOpenApi\Builders\Components\CallbacksBuilder;
 use Vyuldashev\LaravelOpenApi\Builders\Components\RequestBodiesBuilder;
@@ -23,7 +24,7 @@ public function boot(): void
     {
         if ($this->app->runningInConsole()) {
             $this->publishes([
-                __DIR__.'/../config/openapi.php' => config_path('openapi.php'),
+                __DIR__ . '/../config/openapi.php' => config_path('openapi.php'),
             ], 'openapi-config');
         }
 
@@ -48,7 +49,7 @@ public function boot(): void
             );
         });
 
-        $this->loadRoutesFrom(__DIR__.'/../routes/api.php');
+        $this->loadRoutesFrom(__DIR__ . '/../routes/api.php');
     }
 
     public function register(): void
@@ -77,7 +78,7 @@ public function register(): void
 
     protected function registerAnnotations(): void
     {
-        $files = glob(__DIR__.'/Annotations/*.php');
+        $files = glob(__DIR__ . '/Annotations/*.php');
 
         foreach ($files as $file) {
             AnnotationRegistry::registerFile($file);
@@ -86,36 +87,60 @@ protected function registerAnnotations(): void
 
     protected function callbacksIn(): array
     {
-        return [
+        $directories = $this->getPathsFromConfig('callbacks');
+
+        return array_merge($directories, [
             app_path('OpenApi/Callbacks'),
-        ];
+        ]);
     }
 
     protected function requestBodiesIn(): array
     {
-        return [
+        $directories = $this->getPathsFromConfig('request_bodies');
+
+        return array_merge($directories, [
             app_path('OpenApi/RequestBodies'),
-        ];
+        ]);
     }
 
     protected function responsesIn(): array
     {
-        return [
+        $directories = $this->getPathsFromConfig('responses');
+
+        return array_merge($directories, [
             app_path('OpenApi/Responses'),
-        ];
+        ]);
     }
 
     protected function schemasIn(): array
     {
-        return [
+        $directories = $this->getPathsFromConfig('schemas');
+
+        return array_merge($directories, [
             app_path('OpenApi/Schemas'),
-        ];
+        ]);
     }
 
     protected function securitySchemesIn(): array
     {
-        return [
+        $directories = $this->getPathsFromConfig('security_schemes');
+
+        return array_merge($directories, [
             app_path('OpenApi/SecuritySchemes'),
-        ];
+        ]);
+    }
+
+    protected function getPathsFromConfig(string $type): array
+    {
+        $directories = config("openapi.paths.{$type}", []);
+
+        foreach ($directories as &$directory) {
+            $directory = glob(app_path($directory), GLOB_ONLYDIR);
+        }
+
+        return (new Collection($directories))
+            ->flatten()
+            ->unique()
+            ->toArray();
     }
 }