First commit for Swagger doc support

dennisameling · May 3, 2020 · 662bb0a · 662bb0a
1 parent a821bc1
commit 662bb0a
Show file tree

Hide file tree

Showing 5 changed files with 542 additions and 226 deletions.
diff --git a/app/AppKernel.php b/app/AppKernel.php
@@ -130,6 +130,7 @@ public function registerBundles(): array
             new Ivory\OrderedFormBundle\IvoryOrderedFormBundle(),
             new Noxlogic\RateLimitBundle\NoxlogicRateLimitBundle(),
             new FM\ElfinderBundle\FMElfinderBundle(),
+            new Nelmio\ApiDocBundle\NelmioApiDocBundle(),
 
             // Mautic Bundles
             new Mautic\ApiBundle\MauticApiBundle(),

diff --git a/app/bundles/CoreBundle/Config/config.php b/app/bundles/CoreBundle/Config/config.php
@@ -69,6 +69,14 @@
                     'url' => '.*/$',
                 ],
             ],
+            'mautic_core_api_swagger' => [
+                'path'       => '/swagger-docs',
+                'controller' => 'nelmio_api_doc.controller.swagger_ui',
+            ],
+            'mautic_core_api_swagger_json' => [
+                'path'       => '/swagger-docs.json',
+                'controller' => 'nelmio_api_doc.controller.swagger',
+            ],
         ],
         'api' => [
             'mautic_core_api_file_list' => [

diff --git a/app/config/config.php b/app/config/config.php
@@ -323,3 +323,29 @@
         ],
     ],
 ]);
+
+// Nelmio Swagger config
+$container->loadFromExtension('nelmio_api_doc', [
+    'areas' => [
+        'path_patterns' => [
+            '^/api(?!/doc$)',
+        ],
+    ],
+    'documentation' => [
+        'host'    => 'your_mautic_host.local',
+        'schemes' => ['http', 'https'],
+        'info'    => [
+            'title'       => 'Mautic API docs',
+            'description' => 'Auto-generated Swagger documentation.',
+            'version'     => '3.0.0',
+        ],
+        'securityDefinitions' => [
+            'Basic' => [
+                'type' => 'basic',
+            ],
+        ],
+        'security' => [
+            ['Basic' => []],
+        ],
+    ],
+]);
diff --git a/composer.json b/composer.json
@@ -108,7 +108,8 @@
         "leezy/pheanstalk-bundle": "^4.0",
         "tightenco/collect": "^6.13",
         "kamermans/guzzle-oauth2-subscriber": "^1.0",
-        "barryvdh/elfinder-flysystem-driver": "^0.2.1"
+        "barryvdh/elfinder-flysystem-driver": "^0.2.1",
+        "nelmio/api-doc-bundle": "^3.6"
     },
     "require-dev": {
         "symfony/web-profiler-bundle": "~3.4.0",