Merge pull request #24 from nextapps-be/feature/add-stylesheet

Config option to add css to customize swagger-ui
wotzebra · Oct 30, 2023 · 171adce · 171adce
2 parents 8b9c603 + 33cf215
commit 171adce
Show file tree

Hide file tree

Showing 3 changed files with 25 additions and 0 deletions.
diff --git a/config/swagger-ui.php b/config/swagger-ui.php
@@ -46,6 +46,12 @@
                 'client_id' => env('SWAGGER_UI_OAUTH_CLIENT_ID'),
                 'client_secret' => env('SWAGGER_UI_OAUTH_CLIENT_SECRET'),
             ],
+
+            /*
+             * Path to a custom stylesheet file if you want to customize the look and feel of swagger-ui.
+             * The content of the file will be read and added into a style-tag on the swagger-ui page.
+             */
+            'stylesheet' => null,
         ],
     ],
 ];
diff --git a/resources/views/index.blade.php b/resources/views/index.blade.php
@@ -22,6 +22,10 @@
                 background: #fafafa;
             }
         </style>
+
+        @if (! empty($data['stylesheet']))
+            <style>{{ file_get_contents($data['stylesheet']) }}</style>
+        @endif
     </head>
     <body>
         <div id="swagger-ui"></div>

diff --git a/tests/SwaggerUiRouteTest.php b/tests/SwaggerUiRouteTest.php
@@ -66,4 +66,19 @@ public function it_applies_middleware_from_config()
 
         $this->assertRouteUsesMiddleware('swagger-with-versions.index', ['web']);
     }
+
+    /** @test */
+    public function it_includes_content_of_custom_stylesheet()
+    {
+        file_put_contents(
+            $path = resource_path('custom-swagger-ui-styling.css'),
+            $content = '.foo .bar { background-color: red; }'
+        );
+
+        config()->set('swagger-ui.files.0.stylesheet', $path);
+
+        $this->get('swagger')
+            ->assertStatus(200)
+            ->assertSee("<style>{$content}</style>", false);
+    }
 }