route.blade.php 2.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778
  1. <!-- START_{{$parsedRoute['id']}} -->
  2. @if($parsedRoute['title'] != '')## {{ $parsedRoute['title']}}
  3. @else## {{$parsedRoute['uri']}}
  4. @endif
  5. @if($parsedRoute['description'])
  6. {!! $parsedRoute['description'] !!}
  7. @endif
  8. > Example request:
  9. ```bash
  10. curl -X {{$parsedRoute['methods'][0]}} {{$parsedRoute['methods'][0] == 'GET' ? '-G ' : ''}}"{{ trim(config('app.docs_url') ?: config('app.url'), '/')}}/{{ ltrim($parsedRoute['uri'], '/') }}" \
  11. -H "Accept: application/json"@if(count($parsedRoute['headers'])) \
  12. @foreach($parsedRoute['headers'] as $header => $value)
  13. -H "{{$header}}: {{$value}}" @if(! ($loop->last))\
  14. @endif
  15. @endforeach
  16. @endif
  17. @if(count($parsedRoute['parameters'])) \
  18. @foreach($parsedRoute['parameters'] as $attribute => $parameter)
  19. -d "{{$attribute}}"={{$parameter['value']}} @if(! ($loop->last))\
  20. @endif
  21. @endforeach
  22. @endif
  23. ```
  24. ```javascript
  25. var settings = {
  26. "async": true,
  27. "crossDomain": true,
  28. "url": "{{ rtrim(config('app.docs_url') ?: config('app.url'), '/') }}/{{ ltrim($parsedRoute['uri'], '/') }}",
  29. "method": "{{$parsedRoute['methods'][0]}}",
  30. @if(count($parsedRoute['parameters']))
  31. "data": {!! str_replace("\n}","\n }", str_replace(' ',' ',json_encode(array_combine(array_keys($parsedRoute['parameters']), array_map(function($param){ return $param['value']; },$parsedRoute['parameters'])), JSON_PRETTY_PRINT))) !!},
  32. @endif
  33. "headers": {
  34. "accept": "application/json",
  35. @foreach($parsedRoute['headers'] as $header => $value)
  36. "{{$header}}": "{{$value}}",
  37. @endforeach
  38. }
  39. }
  40. $.ajax(settings).done(function (response) {
  41. console.log(response);
  42. });
  43. ```
  44. @if(in_array('GET',$parsedRoute['methods']) || (isset($parsedRoute['showresponse']) && $parsedRoute['showresponse']))
  45. > Example response:
  46. ```json
  47. @if(is_object($parsedRoute['response']) || is_array($parsedRoute['response']))
  48. {!! json_encode($parsedRoute['response'], JSON_PRETTY_PRINT | JSON_UNESCAPED_UNICODE) !!}
  49. @else
  50. {!! json_encode(json_decode($parsedRoute['response']), JSON_PRETTY_PRINT | JSON_UNESCAPED_UNICODE) !!}
  51. @endif
  52. ```
  53. @endif
  54. ### HTTP Request
  55. @foreach($parsedRoute['methods'] as $method)
  56. `{{$method}} {{$parsedRoute['uri']}}`
  57. @endforeach
  58. @if(count($parsedRoute['parameters']))
  59. #### Parameters
  60. Parameter | Type | Status | Description
  61. --------- | ------- | ------- | ------- | -----------
  62. @foreach($parsedRoute['parameters'] as $attribute => $parameter)
  63. {{$attribute}} | {{$parameter['type']}} | @if($parameter['required']) required @else optional @endif | {!! $parameter['description'] !!}
  64. @endforeach
  65. @endif
  66. <!-- END_{{$parsedRoute['id']}} -->