Use an array of API definition in a Swagger UI view (#636)

zakhar-huzenko · web-flow · commit b16d7535080a · 2025-02-12T08:09:03.000+02:00
* Use an array of API definition in a Swagger UI view

* Use an array of API definition in a Swagger UI view

* Refactor to use response helper
diff --git a/resources/views/index.blade.php b/resources/views/index.blade.php
@@ -2,7 +2,7 @@
 <html lang="en">
 <head>
     <meta charset="UTF-8">
-    <title>{{config('l5-swagger.documentations.'.$documentation.'.api.title')}}</title>
+    <title>{{ $documentationTitle }}</title>
     <link rel="stylesheet" type="text/css" href="{{ l5_swagger_asset($documentation, 'swagger-ui.css') }}">
     <link rel="icon" type="image/png" href="{{ l5_swagger_asset($documentation, 'favicon-32x32.png') }}" sizes="32x32"/>
     <link rel="icon" type="image/png" href="{{ l5_swagger_asset($documentation, 'favicon-16x16.png') }}" sizes="16x16"/>
@@ -123,10 +123,17 @@
 <script src="{{ l5_swagger_asset($documentation, 'swagger-ui-standalone-preset.js') }}"></script>
 <script>
     window.onload = function() {
+        const urls = [];
+
+        @foreach($urlsToDocs as $title => $url)
+            urls.push({name: "{{ $title }}", url: "{{ $url }}"});
+        @endforeach
+
         // Build a system
         const ui = SwaggerUIBundle({
             dom_id: '#swagger-ui',
-            url: "{!! $urlToDocs !!}",
+            urls: urls,
+            "urls.primaryName": "{{ $documentationTitle }}",
             operationsSorter: {!! isset($operationsSorter) ? '"' . $operationsSorter . '"' : 'null' !!},
             configUrl: {!! isset($configUrl) ? '"' . $configUrl . '"' : 'null' !!},
             validatorUrl: {!! isset($validatorUrl) ? '"' . $validatorUrl . '"' : 'null' !!},
diff --git a/src/Http/Controllers/SwaggerController.php b/src/Http/Controllers/SwaggerController.php
@@ -9,7 +9,7 @@
 use Illuminate\Routing\Controller as BaseController;
 use Illuminate\Support\Facades\Log;
 use Illuminate\Support\Facades\Request as RequestFacade;
-use Illuminate\Support\Facades\Response as ResponseFacade;
+use L5Swagger\ConfigFactory;
 use L5Swagger\Exceptions\L5SwaggerException;
 use L5Swagger\GeneratorFactory;
 
@@ -20,9 +20,17 @@ class SwaggerController extends BaseController
      */
     protected $generatorFactory;
 
-    public function __construct(GeneratorFactory $generatorFactory)
-    {
+    /**
+     * @var ConfigFactory
+     */
+    protected $configFactory;
+
+    public function __construct(
+        GeneratorFactory $generatorFactory,
+        ConfigFactory $configFactory
+    ) {
         $this->generatorFactory = $generatorFactory;
+        $this->configFactory = $configFactory;
     }
 
     /**
@@ -76,13 +84,13 @@ public function docs(Request $request)
         $content = $fileSystem->get($filePath);
 
         if ($yamlFormat) {
-            return ResponseFacade::make($content, 200, [
+            return response($content, 200, [
                 'Content-Type' => 'application/yaml',
                 'Content-Disposition' => 'inline',
             ]);
         }
 
-        return ResponseFacade::make($content, 200, [
+        return response($content, 200, [
             'Content-Type' => 'application/json',
         ]);
     }
@@ -97,8 +105,9 @@ public function api(Request $request)
     {
         $documentation = $request->offsetGet('documentation');
         $config = $request->offsetGet('config');
+        $proxy = $config['proxy'];
 
-        if ($proxy = $config['proxy']) {
+        if ($proxy) {
             if (! is_array($proxy)) {
                 $proxy = [$proxy];
             }
@@ -113,14 +122,17 @@ public function api(Request $request)
         }
 
         $urlToDocs = $this->generateDocumentationFileURL($documentation, $config);
+        $urlsToDocs = $this->getAllDocumentationUrls();
         $useAbsolutePath = config('l5-swagger.documentations.'.$documentation.'.paths.use_absolute_path', true);
 
         // Need the / at the end to avoid CORS errors on Homestead systems.
-        return ResponseFacade::make(
+        return response(
             view('l5-swagger::index', [
                 'documentation' => $documentation,
+                'documentationTitle' => $config['api']['title'] ?? $documentation,
                 'secure' => RequestFacade::secure(),
-                'urlToDocs' => $urlToDocs,
+                'urlToDocs' => $urlToDocs, // Is not used in the view, but still passed for backwards compatibility
+                'urlsToDocs' => $urlsToDocs,
                 'operationsSorter' => $config['operations_sort'],
                 'configUrl' => $config['additional_config_url'],
                 'validatorUrl' => $config['validator_url'],
@@ -173,4 +185,23 @@ protected function generateDocumentationFileURL(string $documentation, array $co
             $useAbsolutePath
         );
     }
+
+    /**
+     * @return array<string, string> [title => url]
+     */
+    protected function getAllDocumentationUrls(): array
+    {
+        $documentations = array_keys(config('l5-swagger.documentations', []));
+
+        $urlsToDocs = [];
+
+        foreach ($documentations as $documentationName) {
+            $config = $this->configFactory->documentationConfig($documentationName);
+            $title = $config['api']['title'] ?? $documentationName;
+
+            $urlsToDocs[$title] = $this->generateDocumentationFileURL($documentationName, $config);
+        }
+
+        return $urlsToDocs;
+    }
 }
