@@ -64,14 +64,14 @@ discard block |
||
| 64 | 64 | |
| 65 | 65 | private function getAllRoutes(bool $usingDingoRouter) |
| 66 | 66 | { |
| 67 | - if (! $usingDingoRouter) { |
|
| 67 | + if (!$usingDingoRouter) { |
|
| 68 | 68 | return RouteFacade::getRoutes(); |
| 69 | 69 | } |
| 70 | 70 | |
| 71 | 71 | $allRouteCollections = app(\Dingo\Api\Routing\Router::class)->getRoutes(); |
| 72 | 72 | |
| 73 | 73 | return collect($allRouteCollections) |
| 74 | - ->flatMap(function (RouteCollection $collection) { |
|
| 74 | + ->flatMap(function(RouteCollection $collection) { |
|
| 75 | 75 | return $collection->getRoutes(); |
| 76 | 76 | })->toArray(); |
| 77 | 77 | } |
@@ -79,7 +79,7 @@ discard block |
||
| 79 | 79 | private function shouldIncludeRoute(Route $route, array $routeRule, array $mustIncludes, bool $usingDingoRouter) |
| 80 | 80 | { |
| 81 | 81 | $matchesVersion = $usingDingoRouter |
| 82 | - ? ! empty(array_intersect($route->versions(), $routeRule['match']['versions'] ?? [])) |
|
| 82 | + ? !empty(array_intersect($route->versions(), $routeRule['match']['versions'] ?? [])) |
|
| 83 | 83 | : true; |
| 84 | 84 | |
| 85 | 85 | return Str::is($mustIncludes, $route->getName()) |
@@ -20,7 +20,7 @@ |
||
| 20 | 20 | |
| 21 | 21 | $class = new ReflectionClass($className); |
| 22 | 22 | |
| 23 | - if (! $class->hasMethod($methodName)) { |
|
| 23 | + if (!$class->hasMethod($methodName)) { |
|
| 24 | 24 | throw new \Exception("Error while fetching docblock for route: Class $className does not contain method $methodName"); |
| 25 | 25 | } |
| 26 | 26 | |
@@ -43,7 +43,7 @@ discard block |
||
| 43 | 43 | protected function getDocBlockResponses(array $tags) |
| 44 | 44 | { |
| 45 | 45 | $responseTags = array_values( |
| 46 | - array_filter($tags, function ($tag) { |
|
| 46 | + array_filter($tags, function($tag) { |
|
| 47 | 47 | return $tag instanceof Tag && strtolower($tag->getName()) === 'response'; |
| 48 | 48 | }) |
| 49 | 49 | ); |
@@ -52,7 +52,7 @@ discard block |
||
| 52 | 52 | return null; |
| 53 | 53 | } |
| 54 | 54 | |
| 55 | - $responses = array_map(function (Tag $responseTag) { |
|
| 55 | + $responses = array_map(function(Tag $responseTag) { |
|
| 56 | 56 | preg_match('/^(\d{3})?\s?([\s\S]*)$/', $responseTag->getContent(), $result); |
| 57 | 57 | |
| 58 | 58 | $status = $result[1] ?: 200; |
@@ -55,10 +55,10 @@ discard block |
||
| 55 | 55 | private function getUrlParametersFromDocBlock($tags) |
| 56 | 56 | { |
| 57 | 57 | $parameters = collect($tags) |
| 58 | - ->filter(function ($tag) { |
|
| 58 | + ->filter(function($tag) { |
|
| 59 | 59 | return $tag instanceof Tag && $tag->getName() === 'urlParam'; |
| 60 | 60 | }) |
| 61 | - ->mapWithKeys(function (Tag $tag) { |
|
| 61 | + ->mapWithKeys(function(Tag $tag) { |
|
| 62 | 62 | // Format: |
| 63 | 63 | // @urlParam <name> <"required" (optional)> <description> |
| 64 | 64 | // Examples: |
@@ -82,7 +82,7 @@ discard block |
||
| 82 | 82 | } |
| 83 | 83 | |
| 84 | 84 | list($description, $value) = $this->parseParamDescription($description, 'string'); |
| 85 | - if (is_null($value) && ! $this->shouldExcludeExample($tag->getContent())) { |
|
| 85 | + if (is_null($value) && !$this->shouldExcludeExample($tag->getContent())) { |
|
| 86 | 86 | $value = Str::contains($description, ['number', 'count', 'page']) |
| 87 | 87 | ? $this->generateDummyValue('integer') |
| 88 | 88 | : $this->generateDummyValue('string'); |
@@ -55,10 +55,10 @@ discard block |
||
| 55 | 55 | private function getQueryParametersFromDocBlock($tags) |
| 56 | 56 | { |
| 57 | 57 | $parameters = collect($tags) |
| 58 | - ->filter(function ($tag) { |
|
| 58 | + ->filter(function($tag) { |
|
| 59 | 59 | return $tag instanceof Tag && $tag->getName() === 'queryParam'; |
| 60 | 60 | }) |
| 61 | - ->mapWithKeys(function (Tag $tag) { |
|
| 61 | + ->mapWithKeys(function(Tag $tag) { |
|
| 62 | 62 | // Format: |
| 63 | 63 | // @queryParam <name> <"required" (optional)> <description> |
| 64 | 64 | // Examples: |
@@ -82,7 +82,7 @@ discard block |
||
| 82 | 82 | } |
| 83 | 83 | |
| 84 | 84 | list($description, $value) = $this->parseParamDescription($description, 'string'); |
| 85 | - if (is_null($value) && ! $this->shouldExcludeExample($tag->getContent())) { |
|
| 85 | + if (is_null($value) && !$this->shouldExcludeExample($tag->getContent())) { |
|
| 86 | 86 | $value = Str::contains($description, ['number', 'count', 'page']) |
| 87 | 87 | ? $this->generateDummyValue('integer') |
| 88 | 88 | : $this->generateDummyValue('string'); |
@@ -54,10 +54,10 @@ discard block |
||
| 54 | 54 | private function getBodyParametersFromDocBlock($tags) |
| 55 | 55 | { |
| 56 | 56 | $parameters = collect($tags) |
| 57 | - ->filter(function ($tag) { |
|
| 57 | + ->filter(function($tag) { |
|
| 58 | 58 | return $tag instanceof Tag && $tag->getName() === 'bodyParam'; |
| 59 | 59 | }) |
| 60 | - ->mapWithKeys(function (Tag $tag) { |
|
| 60 | + ->mapWithKeys(function(Tag $tag) { |
|
| 61 | 61 | // Format: |
| 62 | 62 | // @bodyParam <name> <type> <"required" (optional)> <description> |
| 63 | 63 | // Examples: |
@@ -82,7 +82,7 @@ discard block |
||
| 82 | 82 | |
| 83 | 83 | $type = $this->normalizeParameterType($type); |
| 84 | 84 | list($description, $example) = $this->parseParamDescription($description, $type); |
| 85 | - $value = is_null($example) && ! $this->shouldExcludeExample($tag->getContent()) |
|
| 85 | + $value = is_null($example) && !$this->shouldExcludeExample($tag->getContent()) |
|
| 86 | 86 | ? $this->generateDummyValue($type) |
| 87 | 87 | : $example; |
| 88 | 88 | |
@@ -18,7 +18,7 @@ |
||
| 18 | 18 | Route::prefix($path) |
| 19 | 19 | ->namespace('\Mpociot\ApiDoc\Http') |
| 20 | 20 | ->middleware(static::middleware()) |
| 21 | - ->group(function () { |
|
| 21 | + ->group(function() { |
|
| 22 | 22 | Route::get('/', 'Controller@html')->name('apidoc'); |
| 23 | 23 | Route::get('.json', 'Controller@json')->name('apidoc.json'); |
| 24 | 24 | }); |
@@ -7,7 +7,7 @@ |
||
| 7 | 7 | |
| 8 | 8 | Route::namespace('\Mpociot\ApiDoc\Http') |
| 9 | 9 | ->middleware($middleware) |
| 10 | - ->group(function () use ($prefix) { |
|
| 10 | + ->group(function() use ($prefix) { |
|
| 11 | 11 | Route::get($prefix, 'Controller@html')->name('apidoc'); |
| 12 | 12 | Route::get("$prefix.json", 'Controller@json')->name('apidoc.json'); |
| 13 | 13 | }); |
@@ -114,8 +114,8 @@ discard block |
||
| 114 | 114 | $generatedDocumentation = file_get_contents($targetFile); |
| 115 | 115 | $compareDocumentation = file_get_contents($compareFile); |
| 116 | 116 | |
| 117 | - $parsedRouteOutput->transform(function (Collection $routeGroup) use ($generatedDocumentation, $compareDocumentation) { |
|
| 118 | - return $routeGroup->transform(function (array $route) use ($generatedDocumentation, $compareDocumentation) { |
|
| 117 | + $parsedRouteOutput->transform(function(Collection $routeGroup) use ($generatedDocumentation, $compareDocumentation) { |
|
| 118 | + return $routeGroup->transform(function(array $route) use ($generatedDocumentation, $compareDocumentation) { |
|
| 119 | 119 | if (preg_match('/<!-- START_' . $route['id'] . ' -->(.*)<!-- END_' . $route['id'] . ' -->/is', $generatedDocumentation, $existingRouteDoc)) { |
| 120 | 120 | $routeDocumentationChanged = (preg_match('/<!-- START_' . $route['id'] . ' -->(.*)<!-- END_' . $route['id'] . ' -->/is', $compareDocumentation, $lastDocWeGeneratedForThisRoute) && $lastDocWeGeneratedForThisRoute[1] !== $existingRouteDoc[1]); |
| 121 | 121 | if ($routeDocumentationChanged === false || $this->forceIt) { |
@@ -148,7 +148,7 @@ discard block |
||
| 148 | 148 | |
| 149 | 149 | $this->output->info('Writing index.md and source files to: ' . $this->sourceOutputPath); |
| 150 | 150 | |
| 151 | - if (! is_dir($this->sourceOutputPath)) { |
|
| 151 | + if (!is_dir($this->sourceOutputPath)) { |
|
| 152 | 152 | $documentarian = new Documentarian(); |
| 153 | 153 | $documentarian->create($this->sourceOutputPath); |
| 154 | 154 | } |
@@ -174,14 +174,14 @@ discard block |
||
| 174 | 174 | |
| 175 | 175 | public function generateMarkdownOutputForEachRoute(Collection $parsedRoutes, array $settings): Collection |
| 176 | 176 | { |
| 177 | - $parsedRouteOutput = $parsedRoutes->map(function (Collection $routeGroup) use ($settings) { |
|
| 178 | - return $routeGroup->map(function (array $route) use ($settings) { |
|
| 179 | - if (count($route['cleanBodyParameters']) && ! isset($route['headers']['Content-Type'])) { |
|
| 177 | + $parsedRouteOutput = $parsedRoutes->map(function(Collection $routeGroup) use ($settings) { |
|
| 178 | + return $routeGroup->map(function(array $route) use ($settings) { |
|
| 179 | + if (count($route['cleanBodyParameters']) && !isset($route['headers']['Content-Type'])) { |
|
| 180 | 180 | // Set content type if the user forgot to set it |
| 181 | 181 | $route['headers']['Content-Type'] = 'application/json'; |
| 182 | 182 | } |
| 183 | 183 | |
| 184 | - $hasRequestOptions = ! empty($route['headers']) || ! empty($route['cleanQueryParameters']) || ! empty($route['cleanBodyParameters']); |
|
| 184 | + $hasRequestOptions = !empty($route['headers']) || !empty($route['cleanQueryParameters']) || !empty($route['cleanBodyParameters']); |
|
| 185 | 185 | $route['output'] = (string) view('apidoc::partials.route') |
| 186 | 186 | ->with('hasRequestOptions', $hasRequestOptions) |
| 187 | 187 | ->with('route', $route) |
@@ -253,7 +253,7 @@ discard block |
||
| 253 | 253 | protected function copyAssetsFromSourceFolderToPublicFolder(): void |
| 254 | 254 | { |
| 255 | 255 | $publicPath = 'public/docs'; |
| 256 | - if (! is_dir($publicPath)) { |
|
| 256 | + if (!is_dir($publicPath)) { |
|
| 257 | 257 | mkdir($publicPath, 0777, true); |
| 258 | 258 | mkdir("{$publicPath}/css"); |
| 259 | 259 | mkdir("{$publicPath}/js"); |
@@ -274,7 +274,7 @@ discard block |
||
| 274 | 274 | rename("{$this->sourceOutputPath}/index.html", "{$this->outputPath}/index.html"); |
| 275 | 275 | } else { |
| 276 | 276 | // Move output to resources/views |
| 277 | - if (! is_dir($this->outputPath)) { |
|
| 277 | + if (!is_dir($this->outputPath)) { |
|
| 278 | 278 | mkdir($this->outputPath); |
| 279 | 279 | } |
| 280 | 280 | rename("{$this->sourceOutputPath}/index.html", "$this->outputPath/index.blade.php"); |