Merge pull request #2 from overint/route-filter

Add ability to filter routes to a certain prefix

Author: mtrajano

README.md

@@ -16,6 +16,8 @@ You can also override the default config provided by the application by running
 
 Generating the swagger documentation is easy, simply run `php artisan laravel-swagger:generate` in your project root. Keep in mind the command will simply print out the output in your console. If you want the docs saved in a file you can reroute the output like so: `php artisan laravel-swagger:generate > swagger.json`
 
+If you wish to generate docs for a subset of your routes, you can pass a filter using `--filter`, for example: `php artisan laravel-swagger:generate --filter="/api"`
+
 By default, laravel-swagger prints out the documentation in json format, if you want it in YAML format you can override the format using the `--format` flag. Make sure to have the yaml extension installed if you choose to do so.
 
 Format options are:<br>

src/GenerateSwaggerDoc.php

@@ -12,7 +12,8 @@ class GenerateSwaggerDoc extends Command
      * @var string
      */
     protected $signature = 'laravel-swagger:generate
-                            {--format=json : The format of the output, current options are json and yaml}';
+                            {--format=json : The format of the output, current options are json and yaml}
+                            {--filter= : Filter to a specific route prefix, such as /api or /v2/api}';
 
     /**
      * The console command description.
@@ -30,7 +31,7 @@ public function handle()
     {
         $config = config('laravel-swagger');
 
-        $docs = (new Generator($config))->generate();
+        $docs = (new Generator($config, $this->option('filter') ?: null))->generate();
 
         $formattedDocs = (new FormatterManager($docs))
             ->setFormat($this->option('format'))

src/Generator.php

@@ -11,6 +11,8 @@ class Generator
 {
     protected $config;
 
+    protected $routeFilter;
+
     protected $docs;
 
     protected $uri;
@@ -21,9 +23,10 @@ class Generator
 
     protected $action;
 
-    public function __construct($config)
+    public function __construct($config, $routeFilter = null)
     {
         $this->config = $config;
+        $this->routeFilter = $routeFilter;
     }
 
     public function generate()
@@ -33,6 +36,11 @@ public function generate()
         foreach ($this->getAppRoutes() as $route) {
             $this->originalUri = $uri = $this->getRouteUri($route);
             $this->uri = strip_optional_char($uri);
+
+            if ($this->routeFilter && !preg_match('/^' . preg_quote($this->routeFilter, '/') . '/', $this->uri)) {
+                continue;
+            }
+
             $this->action = $route->getAction('uses');
             $methods = $route->methods();
 

tests/GeneratorTest.php

@@ -43,6 +43,8 @@ public function testHasPaths($docs)
         $this->assertEquals([
             '/users',
             '/users/{id}',
+            '/api',
+            '/api/store',
         ], array_keys($docs['paths']));
 
         return $docs['paths'];
@@ -105,4 +107,34 @@ public function testOptionalData()
         $this->assertContains('application/json', $docs['consumes']);
         $this->assertContains('application/json', $docs['produces']);
     }
-}
+
+    /**
+     * @param string|null $routeFilter
+     * @param array $expectedRoutes
+     * 
+     * @dataProvider filtersRoutesProvider
+     */
+    public function testFiltersRoutes($routeFilter, $expectedRoutes)
+    {
+        $this->generator = new Generator(
+            $this->config = config('laravel-swagger'),
+            $routeFilter
+        );
+
+        $docs = $this->generator->generate();
+
+        $this->assertEquals($expectedRoutes, array_keys($docs['paths']));
+    }
+
+    /**
+     * @return array
+     */
+    public function filtersRoutesProvider()
+    {
+        return [
+            'No Filter' => [null, ['/users', '/users/{id}', '/api', '/api/store']],
+            '/api Filter' => ['/api', ['/api', '/api/store']],
+            '/=nonexistant Filter' => ['/nonexistant', []],
+        ];
+    }
+}

tests/Stubs/Controllers/ApiController.php

@@ -0,0 +1,18 @@
+<?php
+
+namespace Mtrajano\LaravelSwagger\Tests\Stubs\Controllers;
+
+use Illuminate\Routing\Controller;
+
+class ApiController extends Controller
+{
+    public function index()
+    {
+        return json_encode(['result' => 'success']);
+    }
+
+    public function store()
+    {
+        return json_encode(['result' => 'success']);
+    }
+}

tests/TestCase.php

@@ -16,5 +16,7 @@ protected function getEnvironmentSetUp($app)
         $app['router']->get('/users', 'Mtrajano\\LaravelSwagger\\Tests\\Stubs\\Controllers\\UserController@index');
         $app['router']->get('/users/{id}', 'Mtrajano\\LaravelSwagger\\Tests\\Stubs\\Controllers\\UserController@show');
         $app['router']->post('/users', 'Mtrajano\\LaravelSwagger\\Tests\\Stubs\\Controllers\\UserController@store');
+        $app['router']->get('/api', 'Mtrajano\\LaravelSwagger\\Tests\\Stubs\\Controllers\\ApiController@index');
+        $app['router']->put('/api/store', 'Mtrajano\\LaravelSwagger\\Tests\\Stubs\\Controllers\\ApiController@store');
     }
-}
+}