@@ -42,15 +42,15 @@ |
||
| 42 | 42 | |
| 43 | 43 | $documentarian = new Documentarian(); |
| 44 | 44 | |
| 45 | - if (! is_dir($outputPath)) { |
|
| 46 | - $this->error('There is no existing documentation available at '.$outputPath.'.'); |
|
| 45 | + if (!is_dir($outputPath)) { |
|
| 46 | + $this->error('There is no existing documentation available at ' . $outputPath . '.'); |
|
| 47 | 47 | |
| 48 | 48 | return false; |
| 49 | 49 | } |
| 50 | - $this->info('Rebuilding API HTML code from '.$outputPath.'/source/index.md'); |
|
| 50 | + $this->info('Rebuilding API HTML code from ' . $outputPath . '/source/index.md'); |
|
| 51 | 51 | |
| 52 | 52 | $documentarian->generate($outputPath); |
| 53 | 53 | |
| 54 | - $this->info('Wrote HTML documentation to: '.$outputPath.'/index.html'); |
|
| 54 | + $this->info('Wrote HTML documentation to: ' . $outputPath . '/index.html'); |
|
| 55 | 55 | } |
| 56 | 56 | } |
@@ -55,7 +55,7 @@ discard block |
||
| 55 | 55 | ]); |
| 56 | 56 | |
| 57 | 57 | $parsedRoute = [ |
| 58 | - 'id' => md5($this->getUri($route).':'.implode($this->getMethods($route))), |
|
| 58 | + 'id' => md5($this->getUri($route) . ':' . implode($this->getMethods($route))), |
|
| 59 | 59 | 'group' => $routeGroup, |
| 60 | 60 | 'title' => $docBlock['short'], |
| 61 | 61 | 'description' => $docBlock['long'], |
@@ -65,7 +65,7 @@ discard block |
||
| 65 | 65 | 'queryParameters' => $queryParameters, |
| 66 | 66 | 'authenticated' => $this->getAuthStatusFromDocBlock($docBlock['tags']), |
| 67 | 67 | 'response' => $content, |
| 68 | - 'showresponse' => ! empty($content), |
|
| 68 | + 'showresponse' => !empty($content), |
|
| 69 | 69 | ]; |
| 70 | 70 | $parsedRoute['headers'] = $rulesToApply['headers'] ?? []; |
| 71 | 71 | |
@@ -80,10 +80,10 @@ discard block |
||
| 80 | 80 | protected function getBodyParametersFromDocBlock(array $tags) |
| 81 | 81 | { |
| 82 | 82 | $parameters = collect($tags) |
| 83 | - ->filter(function ($tag) { |
|
| 83 | + ->filter(function($tag) { |
|
| 84 | 84 | return $tag instanceof Tag && $tag->getName() === 'bodyParam'; |
| 85 | 85 | }) |
| 86 | - ->mapWithKeys(function ($tag) { |
|
| 86 | + ->mapWithKeys(function($tag) { |
|
| 87 | 87 | preg_match('/(.+?)\s+(.+?)\s+(required\s+)?(.*)/', $tag->getContent(), $content); |
| 88 | 88 | if (empty($content)) { |
| 89 | 89 | // this means only name and type were supplied |
@@ -117,10 +117,10 @@ discard block |
||
| 117 | 117 | protected function getQueryParametersFromDocBlock(array $tags) |
| 118 | 118 | { |
| 119 | 119 | $parameters = collect($tags) |
| 120 | - ->filter(function ($tag) { |
|
| 120 | + ->filter(function($tag) { |
|
| 121 | 121 | return $tag instanceof Tag && $tag->getName() === 'queryParam'; |
| 122 | 122 | }) |
| 123 | - ->mapWithKeys(function ($tag) { |
|
| 123 | + ->mapWithKeys(function($tag) { |
|
| 124 | 124 | preg_match('/(.+?)\s+(required\s+)?(.*)/', $tag->getContent(), $content); |
| 125 | 125 | if (empty($content)) { |
| 126 | 126 | // this means only name was supplied |
@@ -157,7 +157,7 @@ discard block |
||
| 157 | 157 | protected function getAuthStatusFromDocBlock(array $tags) |
| 158 | 158 | { |
| 159 | 159 | $authTag = collect($tags) |
| 160 | - ->first(function ($tag) { |
|
| 160 | + ->first(function($tag) { |
|
| 161 | 161 | return $tag instanceof Tag && strtolower($tag->getName()) === 'authenticated'; |
| 162 | 162 | }); |
| 163 | 163 | |
@@ -228,25 +228,25 @@ discard block |
||
| 228 | 228 | { |
| 229 | 229 | $faker = Factory::create(); |
| 230 | 230 | $fakes = [ |
| 231 | - 'integer' => function () { |
|
| 231 | + 'integer' => function() { |
|
| 232 | 232 | return rand(1, 20); |
| 233 | 233 | }, |
| 234 | - 'number' => function () use ($faker) { |
|
| 234 | + 'number' => function() use ($faker) { |
|
| 235 | 235 | return $faker->randomFloat(); |
| 236 | 236 | }, |
| 237 | - 'float' => function () use ($faker) { |
|
| 237 | + 'float' => function() use ($faker) { |
|
| 238 | 238 | return $faker->randomFloat(); |
| 239 | 239 | }, |
| 240 | - 'boolean' => function () use ($faker) { |
|
| 240 | + 'boolean' => function() use ($faker) { |
|
| 241 | 241 | return $faker->boolean(); |
| 242 | 242 | }, |
| 243 | - 'string' => function () use ($faker) { |
|
| 243 | + 'string' => function() use ($faker) { |
|
| 244 | 244 | return str_random(); |
| 245 | 245 | }, |
| 246 | - 'array' => function () { |
|
| 246 | + 'array' => function() { |
|
| 247 | 247 | return '[]'; |
| 248 | 248 | }, |
| 249 | - 'object' => function () { |
|
| 249 | + 'object' => function() { |
|
| 250 | 250 | return '{}'; |
| 251 | 251 | }, |
| 252 | 252 | ]; |
@@ -15,7 +15,7 @@ discard block |
||
| 15 | 15 | public function __invoke(Route $route, array $tags, array $routeProps) |
| 16 | 16 | { |
| 17 | 17 | $rulesToApply = $routeProps['rules']['response_calls'] ?? []; |
| 18 | - if (! $this->shouldMakeApiCall($route, $rulesToApply)) { |
|
| 18 | + if (!$this->shouldMakeApiCall($route, $rulesToApply)) { |
|
| 19 | 19 | return; |
| 20 | 20 | } |
| 21 | 21 | |
@@ -124,14 +124,14 @@ discard block |
||
| 124 | 124 | // set URL and query parameters |
| 125 | 125 | $uri = $request->getRequestUri(); |
| 126 | 126 | $query = $request->getQueryString(); |
| 127 | - if (! empty($query)) { |
|
| 127 | + if (!empty($query)) { |
|
| 128 | 128 | $uri .= "?$query"; |
| 129 | 129 | } |
| 130 | 130 | $response = call_user_func_array([$dispatcher, strtolower($request->method())], [$uri]); |
| 131 | 131 | |
| 132 | 132 | // the response from the Dingo dispatcher is the 'raw' response from the controller, |
| 133 | 133 | // so we have to ensure it's JSON first |
| 134 | - if (! $response instanceof Response) { |
|
| 134 | + if (!$response instanceof Response) { |
|
| 135 | 135 | $response = response()->json($response); |
| 136 | 136 | } |
| 137 | 137 | |
@@ -238,8 +238,8 @@ discard block |
||
| 238 | 238 | $prefix = 'HTTP_'; |
| 239 | 239 | foreach ($headers as $name => $value) { |
| 240 | 240 | $name = strtr(strtoupper($name), '-', '_'); |
| 241 | - if (! starts_with($name, $prefix) && $name !== 'CONTENT_TYPE') { |
|
| 242 | - $name = $prefix.$name; |
|
| 241 | + if (!starts_with($name, $prefix) && $name !== 'CONTENT_TYPE') { |
|
| 242 | + $name = $prefix . $name; |
|
| 243 | 243 | } |
| 244 | 244 | $server[$name] = $value; |
| 245 | 245 | } |
@@ -15,17 +15,17 @@ |
||
| 15 | 15 | */ |
| 16 | 16 | public function boot() |
| 17 | 17 | { |
| 18 | - $this->loadViewsFrom(__DIR__.'/../resources/views/', 'apidoc'); |
|
| 18 | + $this->loadViewsFrom(__DIR__ . '/../resources/views/', 'apidoc'); |
|
| 19 | 19 | |
| 20 | 20 | $this->publishes([ |
| 21 | - __DIR__.'/../resources/views' => app()->basePath().'/resources/views/vendor/apidoc', |
|
| 21 | + __DIR__ . '/../resources/views' => app()->basePath() . '/resources/views/vendor/apidoc', |
|
| 22 | 22 | ], 'views'); |
| 23 | 23 | |
| 24 | 24 | $this->publishes([ |
| 25 | - __DIR__.'/../config/apidoc.php' => app()->basePath().'/config/apidoc.php', |
|
| 25 | + __DIR__ . '/../config/apidoc.php' => app()->basePath() . '/config/apidoc.php', |
|
| 26 | 26 | ], 'config'); |
| 27 | 27 | |
| 28 | - $this->mergeConfigFrom(__DIR__.'/../config/apidoc.php', 'apidoc'); |
|
| 28 | + $this->mergeConfigFrom(__DIR__ . '/../config/apidoc.php', 'apidoc'); |
|
| 29 | 29 | |
| 30 | 30 | if ($this->app->runningInConsole()) { |
| 31 | 31 | $this->commands([ |
@@ -50,14 +50,14 @@ discard block |
||
| 50 | 50 | |
| 51 | 51 | private function getAllRoutes(bool $usingDingoRouter, array $versions = []) |
| 52 | 52 | { |
| 53 | - if (! $usingDingoRouter) { |
|
| 53 | + if (!$usingDingoRouter) { |
|
| 54 | 54 | return RouteFacade::getRoutes(); |
| 55 | 55 | } |
| 56 | 56 | |
| 57 | 57 | $allRouteCollections = app(\Dingo\Api\Routing\Router::class)->getRoutes(); |
| 58 | 58 | |
| 59 | 59 | return collect($allRouteCollections) |
| 60 | - ->flatMap(function (RouteCollection $collection) { |
|
| 60 | + ->flatMap(function(RouteCollection $collection) { |
|
| 61 | 61 | return $collection->getRoutes(); |
| 62 | 62 | })->toArray(); |
| 63 | 63 | } |
@@ -65,7 +65,7 @@ discard block |
||
| 65 | 65 | private function shouldIncludeRoute(Route $route, array $routeRule, array $mustIncludes, bool $usingDingoRouter) |
| 66 | 66 | { |
| 67 | 67 | $matchesVersion = $usingDingoRouter |
| 68 | - ? ! empty(array_intersect($route->versions(), $routeRule['match']['versions'] ?? [])) |
|
| 68 | + ? !empty(array_intersect($route->versions(), $routeRule['match']['versions'] ?? [])) |
|
| 69 | 69 | : true; |
| 70 | 70 | |
| 71 | 71 | return str_is($mustIncludes, $route->getName()) |
@@ -48,8 +48,8 @@ |
||
| 48 | 48 | /** @var Response[]|null $response */ |
| 49 | 49 | $responses = $strategy($this->route, $tags, $routeProps); |
| 50 | 50 | |
| 51 | - if (! is_null($responses)) { |
|
| 52 | - return array_map(function (Response $response) { |
|
| 51 | + if (!is_null($responses)) { |
|
| 52 | + return array_map(function(Response $response) { |
|
| 53 | 53 | return ['status' => $response->getStatusCode(), 'content' => $this->getResponseContent($response)]; |
| 54 | 54 | }, $responses); |
| 55 | 55 | } |
@@ -32,11 +32,11 @@ discard block |
||
| 32 | 32 | 'description' => '', |
| 33 | 33 | 'schema' => 'https://schema.getpostman.com/json/collection/v2.0.0/collection.json', |
| 34 | 34 | ], |
| 35 | - 'item' => $this->routeGroups->map(function ($routes, $groupName) { |
|
| 35 | + 'item' => $this->routeGroups->map(function($routes, $groupName) { |
|
| 36 | 36 | return [ |
| 37 | 37 | 'name' => $groupName, |
| 38 | 38 | 'description' => '', |
| 39 | - 'item' => $routes->map(function ($route) { |
|
| 39 | + 'item' => $routes->map(function($route) { |
|
| 40 | 40 | $mode = $route['methods'][0] === 'PUT' ? 'urlencoded' : 'formdata'; |
| 41 | 41 | |
| 42 | 42 | return [ |
@@ -46,7 +46,7 @@ discard block |
||
| 46 | 46 | 'method' => $route['methods'][0], |
| 47 | 47 | 'body' => [ |
| 48 | 48 | 'mode' => $mode, |
| 49 | - $mode => collect($route['bodyParameters'])->map(function ($parameter, $key) { |
|
| 49 | + $mode => collect($route['bodyParameters'])->map(function($parameter, $key) { |
|
| 50 | 50 | return [ |
| 51 | 51 | 'key' => $key, |
| 52 | 52 | 'value' => isset($parameter['value']) ? $parameter['value'] : '', |
@@ -34,7 +34,7 @@ discard block |
||
| 34 | 34 | { |
| 35 | 35 | // avoid "holes" in the keys of the filtered array, by using array_values on the filtered array |
| 36 | 36 | $responseFileTags = array_values( |
| 37 | - array_filter($tags, function ($tag) { |
|
| 37 | + array_filter($tags, function($tag) { |
|
| 38 | 38 | return $tag instanceof Tag && strtolower($tag->getName()) === 'responsefile'; |
| 39 | 39 | }) |
| 40 | 40 | ); |
@@ -43,7 +43,7 @@ discard block |
||
| 43 | 43 | return; |
| 44 | 44 | } |
| 45 | 45 | |
| 46 | - return array_map(function (Tag $responseFileTag) { |
|
| 46 | + return array_map(function(Tag $responseFileTag) { |
|
| 47 | 47 | preg_match('/^(\d{3})?\s?([\s\S]*)$/', $responseFileTag->getContent(), $result); |
| 48 | 48 | |
| 49 | 49 | $status = $result[1] ?: 200; |
@@ -74,7 +74,7 @@ discard block |
||
| 74 | 74 | */ |
| 75 | 75 | private function getClassToBeTransformed(array $tags, ReflectionMethod $transformerMethod) |
| 76 | 76 | { |
| 77 | - $modelTag = array_first(array_filter($tags, function ($tag) { |
|
| 77 | + $modelTag = array_first(array_filter($tags, function($tag) { |
|
| 78 | 78 | return ($tag instanceof Tag) && strtolower($tag->getName()) == 'transformermodel'; |
| 79 | 79 | })); |
| 80 | 80 | |
@@ -83,7 +83,7 @@ discard block |
||
| 83 | 83 | $type = $modelTag->getContent(); |
| 84 | 84 | } else { |
| 85 | 85 | $parameter = array_first($transformerMethod->getParameters()); |
| 86 | - if ($parameter->hasType() && ! $parameter->getType()->isBuiltin() && class_exists((string) $parameter->getType())) { |
|
| 86 | + if ($parameter->hasType() && !$parameter->getType()->isBuiltin() && class_exists((string) $parameter->getType())) { |
|
| 87 | 87 | // ladies and gentlemen, we have a type! |
| 88 | 88 | $type = (string) $parameter->getType(); |
| 89 | 89 | } |
@@ -128,7 +128,7 @@ discard block |
||
| 128 | 128 | private function getTransformerTag(array $tags) |
| 129 | 129 | { |
| 130 | 130 | $transFormerTags = array_values( |
| 131 | - array_filter($tags, function ($tag) { |
|
| 131 | + array_filter($tags, function($tag) { |
|
| 132 | 132 | return ($tag instanceof Tag) && in_array(strtolower($tag->getName()), ['transformer', 'transformercollection']); |
| 133 | 133 | }) |
| 134 | 134 | ); |