Allow passing of custom HTML attributes to external UIs

knuckleswtf · Dec 29, 2023 · 411f184 · 411f184
1 parent 0342537
commit 411f184
Show file tree

Hide file tree

Showing 5 changed files with 31 additions and 12 deletions.
diff --git a/config/scribe.php b/config/scribe.php
@@ -73,6 +73,10 @@
         'middleware' => [],
     ],
 
+    'external' => [
+        'html_attributes' => []
+    ],
+
     'try_it_out' => [
         // Add a Try It Out button to your endpoints so consumers can test endpoints right from their browser.
         // Don't forget to enable CORS headers for your endpoints.

diff --git a/resources/views/external/elements.blade.php b/resources/views/external/elements.blade.php
@@ -12,11 +12,15 @@
 <body>
 
 <elements-api
+@foreach($htmlAttributes as $attribute => $value)
+    {{-- Attributes specified first override later ones --}}
+    {!! $attribute !!}="{!! $value !!}"
+@endforeach
     apiDescriptionUrl="{!! $metadata['openapi_spec_url'] !!}"
     router="hash"
     layout="sidebar"
-    hideTryIt="{!! $metadata['try_it_out']['enabled'] == true ? '' : 'true'!!}"
-    logo ="{!! $metadata['logo'] ?: '' !!}"
+    hideTryIt="{!! ($tryItOut['enabled'] ?? true) ? '' : 'true'!!}"
+    logo="{!! $metadata['logo'] !!}"
 />
 
 </body>

diff --git a/resources/views/external/rapidoc.blade.php b/resources/views/external/rapidoc.blade.php
@@ -6,12 +6,17 @@
     <script type="module" src="https://unpkg.com/rapidoc/dist/rapidoc-min.js"></script>
 </head>
 <body>
-<rapi-doc spec-url="{!! $metadata['openapi_spec_url'] !!}"
-          render-style="read"
-          allow-try="{!! $metadata['try_it_out']['enabled'] == true ? 'true' : 'false'!!}"
+<rapi-doc
+@foreach($htmlAttributes as $attribute => $value)
+    {{-- Attributes specified first override later ones --}}
+    {!! $attribute !!}="{!! $value !!}"
+@endforeach
+    spec-url="{!! $metadata['openapi_spec_url'] !!}"
+    render-style="read"
+    allow-try="{!! ($tryItOut['enabled'] ?? true) ? 'true' : 'false'!!}"
 >
-    @if($metadata['logo'] ?: '')
-        <img slot="logo" src="{!! $metadata['logo'] ?: '' !!}"/>
+    @if($metadata['logo'])
+        <img slot="logo" src="{!! $metadata['logo'] !!}"/>
     @endif
 </rapi-doc>
 </body>

diff --git a/resources/views/external/scalar.blade.php b/resources/views/external/scalar.blade.php
@@ -2,10 +2,10 @@
 <html>
 <head>
     <title>{!! $metadata['title'] !!}</title>
-    <meta charset="utf-8" />
+    <meta charset="utf-8"/>
     <meta
-            name="viewport"
-            content="width=device-width, initial-scale=1" />
+        name="viewport"
+        content="width=device-width, initial-scale=1"/>
     <style>
         body {
             margin: 0;
@@ -15,8 +15,12 @@
 <body>
 
 <script
-        id="api-reference"
-        data-url="{!! $metadata['openapi_spec_url'] !!}">
+    id="api-reference"
+@foreach($htmlAttributes as $attribute => $value)
+    {{-- Attributes specified first override later ones --}}
+    {!! $attribute !!}="{!! $value !!}"
+@endforeach
+    data-url="{!! $metadata['openapi_spec_url'] !!}">
 </script>
 <script src="https://cdn.jsdelivr.net/npm/@scalar/api-reference"></script>
 </body>

diff --git a/src/Writing/ExternalHtmlWriter.php b/src/Writing/ExternalHtmlWriter.php
@@ -16,6 +16,7 @@ public function generate(array $groupedEndpoints, string $sourceFolder, string $
             'metadata' => $this->getMetadata(),
             'baseUrl' => $this->baseUrl,
             'tryItOut' => $this->config->get('try_it_out'),
+            'htmlAttributes' => $this->config->get('external.html_attributes', []),
         ])->render();
 
         if (!is_dir($destinationFolder)) {
@@ -44,4 +45,5 @@ public function getMetadata(): array
             "openapi_spec_url" => $openApiSpecUrl ?? null,
         ];
     }
+
 }