|
2 | 2 | title: API Reference |
3 | 3 |
|
4 | 4 | language_tabs: |
5 | | -- javascript |
6 | 5 | - bash |
| 6 | +- javascript |
7 | 7 |
|
8 | 8 | includes: |
9 | 9 |
|
|
19 | 19 |
|
20 | 20 | # Available routes |
21 | 21 | @foreach($parsedRoutes as $parsedRoute) |
22 | | - @if($parsedRoute['title'] != '')## {{ $parsedRoute['title']}} |
23 | | - @else## {{$parsedRoute['uri']}} |
24 | | - @endif |
25 | | - @if($parsedRoute['description']) |
| 22 | +@if($parsedRoute['title'] != '')## {{ $parsedRoute['title']}} |
| 23 | +@else## {{$parsedRoute['uri']}} |
| 24 | +@endif |
| 25 | +@if($parsedRoute['description']) |
26 | 26 |
|
27 | | - {{$parsedRoute['description']}} |
28 | | - @endif |
| 27 | +{{$parsedRoute['description']}} |
| 28 | +@endif |
29 | 29 |
|
30 | | - > Example request: |
| 30 | +> Example request: |
31 | 31 |
|
32 | | - ```bash |
33 | | - curl "{{config('app.url')}}/{{$parsedRoute['uri']}}" \ |
34 | | - -H "Accept: application/json"@if(count($parsedRoute['parameters'])) \ |
35 | | - @foreach($parsedRoute['parameters'] as $attribute => $parameter) |
36 | | - -d "{{$attribute}}"="{{$parameter['value']}}" \ |
37 | | - @endforeach |
38 | | - @endif |
| 32 | +```bash |
| 33 | +curl "{{config('app.url')}}/{{$parsedRoute['uri']}}" \ |
| 34 | +-H "Accept: application/json"@if(count($parsedRoute['parameters'])) \ |
| 35 | +@foreach($parsedRoute['parameters'] as $attribute => $parameter) |
| 36 | + -d "{{$attribute}}"="{{$parameter['value']}}" \ |
| 37 | +@endforeach |
| 38 | +@endif |
39 | 39 |
|
40 | | - ``` |
| 40 | +``` |
41 | 41 |
|
42 | | - ```javascript |
43 | | - var settings = { |
| 42 | +```javascript |
| 43 | +var settings = { |
44 | 44 | "async": true, |
45 | 45 | "crossDomain": true, |
46 | 46 | "url": "{{config('app.url')}}/{{$parsedRoute['uri']}}", |
47 | 47 | "method": "{{$parsedRoute['methods'][0]}}", |
48 | 48 | @if(count($parsedRoute['parameters'])) |
49 | | - "data": {!! str_replace(' ',' ',json_encode(array_combine(array_keys($parsedRoute['parameters']), array_map(function($param){ return $param['value']; },$parsedRoute['parameters'])), JSON_PRETTY_PRINT)) !!}, |
| 49 | +"data": {!! str_replace(' ',' ',json_encode(array_combine(array_keys($parsedRoute['parameters']), array_map(function($param){ return $param['value']; },$parsedRoute['parameters'])), JSON_PRETTY_PRINT)) !!}, |
50 | 50 | @endif |
51 | 51 | "headers": { |
52 | 52 | "accept": "application/json" |
53 | 53 | } |
54 | | - } |
| 54 | +} |
55 | 55 |
|
56 | | - $.ajax(settings).done(function (response) { |
57 | | - console.log(response); |
58 | | - }); |
59 | | - ``` |
60 | | - |
61 | | - @if(in_array('GET',$parsedRoute['methods'])) |
62 | | - > Example response: |
| 56 | +$.ajax(settings).done(function (response) { |
| 57 | +console.log(response); |
| 58 | +}); |
| 59 | +``` |
63 | 60 |
|
64 | | - ```json |
65 | | - {!! $parsedRoute['response'] !!} |
66 | | - ``` |
67 | | - @endif |
| 61 | +@if(in_array('GET',$parsedRoute['methods'])) |
| 62 | + > Example response: |
68 | 63 |
|
69 | | - ### HTTP Request |
70 | | - @foreach($parsedRoute['methods'] as $method) |
71 | | - `{{$method}} {{$parsedRoute['uri']}}` |
| 64 | + ```json |
| 65 | + {!! $parsedRoute['response'] !!} |
| 66 | + ``` |
| 67 | +@endif |
72 | 68 |
|
73 | | - @endforeach |
74 | | - @if(count($parsedRoute['parameters'])) |
| 69 | +### HTTP Request |
| 70 | +@foreach($parsedRoute['methods'] as $method) |
| 71 | +`{{$method}} {{$parsedRoute['uri']}}` |
75 | 72 |
|
76 | | - #### Parameters |
| 73 | +@endforeach |
| 74 | +@if(count($parsedRoute['parameters'])) |
| 75 | +#### Parameters |
77 | 76 |
|
78 | | - Parameter | Type | Status | Description |
79 | | - --------- | ------- | ------- | ------- | ----------- |
80 | | - @foreach($parsedRoute['parameters'] as $attribute => $parameter) |
81 | | - {{$attribute}} | {{$parameter['type']}} | @if($parameter['required']) required @else optional @endif | {!! implode(' ',$parameter['description']) !!} |
82 | | - @endforeach |
83 | | - @endif |
| 77 | +Parameter | Type | Status | Description |
| 78 | +--------- | ------- | ------- | ------- | ----------- |
| 79 | +@foreach($parsedRoute['parameters'] as $attribute => $parameter) |
| 80 | + {{$attribute}} | {{$parameter['type']}} | @if($parameter['required']) required @else optional @endif | {!! implode(' ',$parameter['description']) !!} |
| 81 | +@endforeach |
| 82 | +@endif |
84 | 83 |
|
85 | 84 | @endforeach |
0 commit comments