added more config options, better config structure

Author: mtrajano

config/laravel-swagger.php

@@ -1,9 +1,37 @@
 <?php
 
 return [
+
+    /*
+    |--------------------------------------------------------------------------
+    | Basic Info
+    |--------------------------------------------------------------------------
+    |
+    | The basic info for the application such as the title description,
+    | description, version, etc...
+    |
+    */
+
     'title' => env('APP_NAME'),
+
     'description' => '',
+
     'appVersion' => '1.0.0',
+
     'host' => env('APP_URL'),
+
     'basePath' => '/',
+
+    'schemes' => [
+        // 'http',
+        // 'https',
+    ],
+
+    'consumes' => [
+        // 'application/json',
+    ],
+
+    'produces' => [
+        // 'application/json',
+    ],
 ];

src/Generator.php

@@ -52,7 +52,7 @@ public function generate()
 
     protected function getBaseInfo()
     {
-        return [
+        $baseInfo = [
             'swagger' => '2.0',
             'info' => [
                 'title' => $this->config['title'],
@@ -61,8 +61,23 @@ protected function getBaseInfo()
             ],
             'host' => $this->config['host'],
             'basePath' => $this->config['basePath'],
-            'paths' => [],
         ];
+
+        if (!empty($this->config['schemes'])) {
+            $baseInfo['schemes'] = $this->config['schemes'];
+        }
+
+        if (!empty($this->config['consumes'])) {
+            $baseInfo['consumes'] = $this->config['consumes'];
+        }
+
+        if (!empty($this->config['produces'])) {
+            $baseInfo['produces'] = $this->config['produces'];
+        }
+
+        $baseInfo['paths'] = [];
+
+        return $baseInfo;
     }
 
     protected function getAppRoutes()

tests/GeneratorTest.php

@@ -6,13 +6,17 @@
 
 class GeneratorTest extends TestCase
 {
+    protected $config;
+
     protected $generator;
 
     public function setUp()
     {
         parent::setUp();
 
-        $this->generator = new Generator(config('laravel-swagger'));
+        $this->generator = new Generator(
+            $this->config = config('laravel-swagger')
+        );
     }
 
     public function testBaseInfo()
@@ -60,4 +64,35 @@ public function testPathData($paths)
         $this->assertArrayHasKey('responses', $paths['/users']['post']);
         $this->assertArrayHasKey('parameters', $paths['/users']['post']);
     }
+
+    public function testOptionalData()
+    {
+        $optionalData = [
+            'schemes' => [
+                'http',
+                'https',
+            ],
+
+            'consumes' => [
+                'application/json',
+            ],
+
+            'produces' => [
+                'application/json',
+            ],
+        ];
+
+        $config = array_merge($this->config, $optionalData);
+
+        $docs = (new Generator($config))->generate();
+
+        $this->assertArrayHasKey('schemes', $docs);
+        $this->assertArrayHasKey('consumes', $docs);
+        $this->assertArrayHasKey('produces', $docs);
+
+        $this->assertContains('http', $docs['schemes']);
+        $this->assertContains('https', $docs['schemes']);
+        $this->assertContains('application/json', $docs['consumes']);
+        $this->assertContains('application/json', $docs['produces']);
+    }
 }