tags added to the docs by its controller name

Author: Vignesh C

src/GenerateSwaggerDoc.php

@@ -13,8 +13,9 @@ class GenerateSwaggerDoc extends Command
      */
     protected $signature = 'laravel-swagger:generate
                             {--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}
-                            {--auth= : Authentication to be applied globally}';
+                            {--filter=api : Filter to a specific route prefix, such as /api or /v2/api}
+                            {--auth=jwt : Authentication to be applied globally}
+                            {--host= : Host name of the swagger if you wish to change the default}';
 
     /**
      * The console command description.
@@ -32,7 +33,7 @@ public function handle()
     {
         $config = config('laravel-swagger');
 
-        $docs = (new Generator($config, $this->option('filter') ?: null, $this->option('auth') ?: null))->generate();
+        $docs = (new Generator($config, $this->option('filter') ?: null, $this->option('auth') ?: null, $this->option('host') ?: null))->generate();
 
         $formattedDocs = (new FormatterManager($docs))
             ->setFormat($this->option('format'))

src/Generator.php

@@ -15,6 +15,8 @@ class Generator
 
     protected $auth;
 
+    protected $host;
+
     protected $docs;
 
     protected $uri;
@@ -25,11 +27,12 @@ class Generator
 
     protected $action;
 
-    public function __construct($config, $routeFilter = null, $auth = null)
+    public function __construct($config, $routeFilter = null, $auth = null, $host = null)
     {
         $this->config = $config;
         $this->routeFilter = $routeFilter;
         $this->auth = $auth;
+        $this->host = $host;
     }
 
     public function generate()
@@ -59,6 +62,8 @@ public function generate()
 
                 $this->generatePath();
 
+                $this->addTags($route->getAction());
+
                 $this->addAuthParameters($route->middleware());
             }
         }
@@ -75,7 +80,7 @@ protected function getBaseInfo()
                 'description' => $this->config['description'],
                 'version' => $this->config['appVersion'],
             ],
-            'host' => $this->config['host'],
+            'host' => !empty($this->host) ? $this->host : $this->config['host'],
             'basePath' => $this->config['basePath'],
         ];
 
@@ -136,6 +141,7 @@ protected function generatePath()
 
         $this->docs['paths'][$this->uri][$this->method] = [
             'description' => "$methodDescription {$this->uri}",
+            'tags' => [],
             'responses' => [
                 '200' => [
                     'description' => 'OK'
@@ -180,6 +186,23 @@ protected function getFormRules()
         }
     }
 
+    protected function addTags($controllerArray)
+    {
+        $tagName = $this->getControllerName($controllerArray);
+        $this->docs['paths'][$this->uri][$this->method]['tags'][] = $tagName;
+    }
+
+    protected function getControllerName($controllerArray)
+    {
+        $namespaceReplaced = str_replace($controllerArray['namespace']. '\\', '', $controllerArray['controller']);
+        $actionNameReplaced = substr($namespaceReplaced, 0, strpos($namespaceReplaced, '@'));
+        $controllerReplaced = str_replace('Controller', '', $actionNameReplaced);
+        $controllerNameArray = preg_split('/(?=[A-Z])/', $controllerReplaced);
+        $controllerName = trim(implode(' ', $controllerNameArray));
+
+        return $controllerName;
+    }
+
     protected function addAuthParameters($middlewares)
     {
         if(!empty($this->auth)) {