Merge pull request #100 from hommingcom/master

Fix id navigation and add quality-of-life configuration options
rakutentech · Oct 26, 2022 · d3c6e4a · d3c6e4a
2 parents b8bef51 + 92fd95f
commit d3c6e4a
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 4 deletions.
diff --git a/config/request-docs.php b/config/request-docs.php
@@ -16,6 +16,20 @@
         // \App\Http\Middleware\NotFoundWhenProduction::class,
     ],
 
+    /*
+    * Default headers shown on the request headers editor
+    */
+    'default_request_headers' => [
+        'Accept' => 'application/json',
+        'X-CSRF-TOKEN' => '',
+        'Authorization' => 'Bearer',
+    ],
+
+    /*
+    * Show development relevant metadata on endpoints
+    */
+    'show_development_metadata' => true,
+
     /**
      * Path to to static HTML if using command line.
      */

diff --git a/resources/views/index.blade.php b/resources/views/index.blade.php
@@ -212,10 +212,11 @@ class="inline-flex text-xs"
                         {{$doc['methods'][0]}}
                     </span>
                     <span class="">
-                        <a href="#{{$doc['uri']}}">{{$doc['uri']}}</a>
+                        <a href="#{{$doc['httpMethod'] .'-'. $doc['uri']}}">{{$doc['uri']}}</a>
                     </span>
                 </h1>
                 </div>
+                @if (config('request-docs.show_development_metadata'))
                 <table class="table-fixed text-sm mt-5">
                     <tbody>
                         <tr>
@@ -244,6 +245,7 @@ class="inline-flex text-xs"
                         @endforeach
                     </tbody>
                 </table>
+                @endif
                 <div v-if="docs[{{$index}}]['docBlock']" class="border-2 mr-4 mt-4 p-4 rounded text-sm">
                     <h3 class="font-bold">Description</h3>
                     <hr>
@@ -660,9 +662,7 @@ class="my-prism-editor"
                 filterTerm: ''
             },
             created: function () {
-                axios.defaults.headers.common['X-CSRF-TOKEN'] = document.querySelector('meta[name="csrf-token"]').getAttribute('content'),
-                axios.defaults.headers.common['Authorization'] = 'Bearer '
-                this.requestHeaders = JSON.stringify(axios.defaults.headers.common, null, 2)
+                this.requestHeaders = JSON.stringify({!! json_encode(config('request-docs.default_request_headers')) !!}, null, 2)
             },
             methods: {
                 highlightSidebar(idx) {