Merge pull request #393 from shalvah/v3

Fix issues with rendering example requests

Author: shalvah

resources/views/partials/route.blade.php

@@ -1,15 +1,9 @@
 <!-- START_{{$route['id']}} -->
 @if($route['title'] != '')## {{ $route['title']}}
 @else## {{$route['uri']}}@endif
-@if($route['authenticated'])<small style="
-  padding: 1px 9px 2px;
-  font-weight: bold;
-  white-space: nowrap;
-  color: #ffffff;
-  -webkit-border-radius: 9px;
-  -moz-border-radius: 9px;
-  border-radius: 9px;
-  background-color: #3a87ad;">Requires authentication</small>@endif
+@if($route['authenticated'])
+
+<br><small style="padding: 1px 9px 2px;font-weight: bold;white-space: nowrap;color: #ffffff;-webkit-border-radius: 9px;-moz-border-radius: 9px;border-radius: 9px;background-color: #3a87ad;">Requires authentication</small>@endif
 @if($route['description'])
 
 {!! $route['description'] !!}
@@ -18,20 +12,17 @@
 > Example request:
 
 ```bash
-curl -X {{$route['methods'][0]}} {{$route['methods'][0] == 'GET' ? '-G ' : ''}}"{{ trim(config('app.docs_url') ?: config('app.url'), '/')}}/{{ ltrim($route['uri'], '/') }}" \
-    -H "Accept: application/json"@if(count($route['headers'])) \
+curl -X {{$route['methods'][0]}} {{$route['methods'][0] == 'GET' ? '-G ' : ''}}"{{ trim(config('app.docs_url') ?: config('app.url'), '/')}}/{{ ltrim($route['uri'], '/') }}" @if(count($route['headers']))\
 @foreach($route['headers'] as $header => $value)
-    -H "{{$header}}: {{$value}}" @if(! ($loop->last))\
-    @endif
+    -H "{{$header}}: {{$value}}"@if(! ($loop->last) || ($loop->last && count($route['bodyParameters']))) \
+@endif
 @endforeach
 @endif
-
-@if(count($route['bodyParameters'])) \
 @foreach($route['bodyParameters'] as $attribute => $parameter)
     -d "{{$attribute}}"="{{$parameter['value']}}" @if(! ($loop->last))\
-    @endif
-@endforeach
 @endif
+@endforeach
+
 ```
 
 ```javascript
@@ -44,7 +35,6 @@
 "data": {!! str_replace("\n}","\n    }", str_replace('    ','        ',json_encode(array_combine(array_keys($route['bodyParameters']), array_map(function($param){ return $param['value']; },$route['bodyParameters'])), JSON_PRETTY_PRINT))) !!},
     @endif
 "headers": {
-        "accept": "application/json",
 @foreach($route['headers'] as $header => $value)
         "{{$header}}": "{{$value}}",
 @endforeach

tests/Fixtures/partial_resource_index.md

@@ -38,7 +38,7 @@ var settings = {
     "url": "http://localhost/api/users",
     "method": "GET",
     "headers": {
-        "accept": "application/json",
+        "Accept": "application/json",
     }
 }
 
@@ -78,7 +78,7 @@ var settings = {
     "url": "http://localhost/api/users/create",
     "method": "GET",
     "headers": {
-        "accept": "application/json",
+        "Accept": "application/json",
     }
 }
 

tests/Fixtures/resource_index.md

@@ -38,7 +38,7 @@ var settings = {
     "url": "http://localhost/api/users",
     "method": "GET",
     "headers": {
-        "accept": "application/json",
+        "Accept": "application/json",
     }
 }
 
@@ -78,7 +78,7 @@ var settings = {
     "url": "http://localhost/api/users/create",
     "method": "GET",
     "headers": {
-        "accept": "application/json",
+        "Accept": "application/json",
     }
 }
 
@@ -118,7 +118,7 @@ var settings = {
     "url": "http://localhost/api/users",
     "method": "POST",
     "headers": {
-        "accept": "application/json",
+        "Accept": "application/json",
     }
 }
 
@@ -151,7 +151,7 @@ var settings = {
     "url": "http://localhost/api/users/{user}",
     "method": "GET",
     "headers": {
-        "accept": "application/json",
+        "Accept": "application/json",
     }
 }
 
@@ -191,7 +191,7 @@ var settings = {
     "url": "http://localhost/api/users/{user}/edit",
     "method": "GET",
     "headers": {
-        "accept": "application/json",
+        "Accept": "application/json",
     }
 }
 
@@ -231,7 +231,7 @@ var settings = {
     "url": "http://localhost/api/users/{user}",
     "method": "PUT",
     "headers": {
-        "accept": "application/json",
+        "Accept": "application/json",
     }
 }
 
@@ -266,7 +266,7 @@ var settings = {
     "url": "http://localhost/api/users/{user}",
     "method": "DELETE",
     "headers": {
-        "accept": "application/json",
+        "Accept": "application/json",
     }
 }
 

tests/GenerateDocumentationTest.php

@@ -107,6 +107,12 @@ public function can_parse_resource_routes()
         RouteFacade::resource('/api/users', TestResourceController::class);
 
         config(['apidoc.routes.0.match.prefixes' => ['api/*']]);
+        config([
+            'apidoc.routes.0.apply.headers' => [
+                'Accept' => 'application/json',
+            ],
+        ]);
+
         $this->artisan('apidoc:generate');
 
         $fixtureMarkdown = __DIR__.'/Fixtures/resource_index.md';
@@ -129,6 +135,12 @@ public function can_parse_partial_resource_routes()
         }
 
         config(['apidoc.routes.0.match.prefixes' => ['api/*']]);
+        config([
+            'apidoc.routes.0.apply.headers' => [
+                'Accept' => 'application/json',
+            ],
+        ]);
+
         $this->artisan('apidoc:generate');
 
         $fixtureMarkdown = __DIR__.'/Fixtures/partial_resource_index.md';