|
@@ -70,7 +70,7 @@ discard block |
|
|
block discarded – undo |
|
70
|
70
|
|
|
71
|
71
|
$this->setUserToBeImpersonated($this->option('actAsUserId')); |
|
72
|
72
|
|
|
73
|
|
- if ($routePrefix === null && ! count($allowedRoutes) && $middleware === null) { |
|
|
73
|
+ if ($routePrefix === null && !count($allowedRoutes) && $middleware === null) { |
|
74
|
74
|
$this->error('You must provide either a route prefix or a route or a middleware to generate the documentation.'); |
|
75
|
75
|
|
|
76
|
76
|
return false; |
|
@@ -81,7 +81,7 @@ discard block |
|
|
block discarded – undo |
|
81
|
81
|
} else { |
|
82
|
82
|
$parsedRoutes = $this->processDingoRoutes($generator, $allowedRoutes, $routePrefix, $middleware); |
|
83
|
83
|
} |
|
84
|
|
- $parsedRoutes = collect($parsedRoutes)->groupBy('resource')->sort(function ($a, $b) { |
|
|
84
|
+ $parsedRoutes = collect($parsedRoutes)->groupBy('resource')->sort(function($a, $b) { |
|
85
|
85
|
return strcmp($a->first()['resource'], $b->first()['resource']); |
|
86
|
86
|
}); |
|
87
|
87
|
|
|
@@ -96,15 +96,15 @@ discard block |
|
|
block discarded – undo |
|
96
|
96
|
private function writeMarkdown($parsedRoutes) |
|
97
|
97
|
{ |
|
98
|
98
|
$outputPath = $this->option('output'); |
|
99
|
|
- $targetFile = $outputPath.DIRECTORY_SEPARATOR.'source'.DIRECTORY_SEPARATOR.'index.md'; |
|
100
|
|
- $compareFile = $outputPath.DIRECTORY_SEPARATOR.'source'.DIRECTORY_SEPARATOR.'.compare.md'; |
|
|
99
|
+ $targetFile = $outputPath . DIRECTORY_SEPARATOR . 'source' . DIRECTORY_SEPARATOR . 'index.md'; |
|
|
100
|
+ $compareFile = $outputPath . DIRECTORY_SEPARATOR . 'source' . DIRECTORY_SEPARATOR . '.compare.md'; |
|
101
|
101
|
|
|
102
|
102
|
$infoText = view('apidoc::partials.info') |
|
103
|
103
|
->with('outputPath', ltrim($outputPath, 'public/')) |
|
104
|
|
- ->with('showPostmanCollectionButton', ! $this->option('noPostmanCollection')); |
|
|
104
|
+ ->with('showPostmanCollectionButton', !$this->option('noPostmanCollection')); |
|
105
|
105
|
|
|
106
|
|
- $parsedRouteOutput = $parsedRoutes->map(function ($routeGroup) { |
|
107
|
|
- return $routeGroup->map(function ($route) { |
|
|
106
|
+ $parsedRouteOutput = $parsedRoutes->map(function($routeGroup) { |
|
|
107
|
+ return $routeGroup->map(function($route) { |
|
108
|
108
|
$route['output'] = (string) view('apidoc::partials.route')->with('parsedRoute', $route); |
|
109
|
109
|
|
|
110
|
110
|
return $route; |
|
@@ -128,16 +128,16 @@ discard block |
|
|
block discarded – undo |
|
128
|
128
|
$frontmatter = trim($generatedFrontmatter[1], "\n"); |
|
129
|
129
|
} |
|
130
|
130
|
|
|
131
|
|
- $parsedRouteOutput->transform(function ($routeGroup) use ($generatedDocumentation, $compareDocumentation) { |
|
132
|
|
- return $routeGroup->transform(function ($route) use ($generatedDocumentation, $compareDocumentation) { |
|
133
|
|
- if (preg_match('/<!-- START_'.$route['id'].' -->(.*)<!-- END_'.$route['id'].' -->/is', $generatedDocumentation, $routeMatch)) { |
|
134
|
|
- $routeDocumentationChanged = (preg_match('/<!-- START_'.$route['id'].' -->(.*)<!-- END_'.$route['id'].' -->/is', $compareDocumentation, $compareMatch) && $compareMatch[1] !== $routeMatch[1]); |
|
|
131
|
+ $parsedRouteOutput->transform(function($routeGroup) use ($generatedDocumentation, $compareDocumentation) { |
|
|
132
|
+ return $routeGroup->transform(function($route) use ($generatedDocumentation, $compareDocumentation) { |
|
|
133
|
+ if (preg_match('/<!-- START_' . $route['id'] . ' -->(.*)<!-- END_' . $route['id'] . ' -->/is', $generatedDocumentation, $routeMatch)) { |
|
|
134
|
+ $routeDocumentationChanged = (preg_match('/<!-- START_' . $route['id'] . ' -->(.*)<!-- END_' . $route['id'] . ' -->/is', $compareDocumentation, $compareMatch) && $compareMatch[1] !== $routeMatch[1]); |
|
135
|
135
|
if ($routeDocumentationChanged === false || $this->option('force')) { |
|
136
|
136
|
if ($routeDocumentationChanged) { |
|
137
|
|
- $this->warn('Discarded manual changes for route ['.implode(',', $route['methods']).'] '.$route['uri']); |
|
|
137
|
+ $this->warn('Discarded manual changes for route [' . implode(',', $route['methods']) . '] ' . $route['uri']); |
|
138
|
138
|
} |
|
139
|
139
|
} else { |
|
140
|
|
- $this->warn('Skipping modified route ['.implode(',', $route['methods']).'] '.$route['uri']); |
|
|
140
|
+ $this->warn('Skipping modified route [' . implode(',', $route['methods']) . '] ' . $route['uri']); |
|
141
|
141
|
$route['modified_output'] = $routeMatch[0]; |
|
142
|
142
|
} |
|
143
|
143
|
} |
|
@@ -154,10 +154,10 @@ discard block |
|
|
block discarded – undo |
|
154
|
154
|
->with('frontmatter', $frontmatter) |
|
155
|
155
|
->with('infoText', $infoText) |
|
156
|
156
|
->with('outputPath', $this->option('output')) |
|
157
|
|
- ->with('showPostmanCollectionButton', ! $this->option('noPostmanCollection')) |
|
|
157
|
+ ->with('showPostmanCollectionButton', !$this->option('noPostmanCollection')) |
|
158
|
158
|
->with('parsedRoutes', $parsedRouteOutput); |
|
159
|
159
|
|
|
160
|
|
- if (! is_dir($outputPath)) { |
|
|
160
|
+ if (!is_dir($outputPath)) { |
|
161
|
161
|
$documentarian->create($outputPath); |
|
162
|
162
|
} |
|
163
|
163
|
|
|
@@ -170,24 +170,24 @@ discard block |
|
|
block discarded – undo |
|
170
|
170
|
->with('frontmatter', $frontmatter) |
|
171
|
171
|
->with('infoText', $infoText) |
|
172
|
172
|
->with('outputPath', $this->option('output')) |
|
173
|
|
- ->with('showPostmanCollectionButton', ! $this->option('noPostmanCollection')) |
|
|
173
|
+ ->with('showPostmanCollectionButton', !$this->option('noPostmanCollection')) |
|
174
|
174
|
->with('parsedRoutes', $parsedRouteOutput); |
|
175
|
175
|
|
|
176
|
176
|
file_put_contents($compareFile, $compareMarkdown); |
|
177
|
177
|
|
|
178
|
|
- $this->info('Wrote index.md to: '.$outputPath); |
|
|
178
|
+ $this->info('Wrote index.md to: ' . $outputPath); |
|
179
|
179
|
|
|
180
|
180
|
$this->info('Generating API HTML code'); |
|
181
|
181
|
|
|
182
|
182
|
$documentarian->generate($outputPath); |
|
183
|
183
|
|
|
184
|
|
- $this->info('Wrote HTML documentation to: '.$outputPath.'/public/index.html'); |
|
|
184
|
+ $this->info('Wrote HTML documentation to: ' . $outputPath . '/public/index.html'); |
|
185
|
185
|
|
|
186
|
186
|
|
|
187
|
187
|
if ($this->option('noPostmanCollection') !== true) { |
|
188
|
188
|
$this->info('Generating Postman collection'); |
|
189
|
189
|
|
|
190
|
|
- file_put_contents($outputPath.DIRECTORY_SEPARATOR.'collection.json', $this->generatePostmanCollection($parsedRoutes)); |
|
|
190
|
+ file_put_contents($outputPath . DIRECTORY_SEPARATOR . 'collection.json', $this->generatePostmanCollection($parsedRoutes)); |
|
191
|
191
|
} |
|
192
|
192
|
} |
|
193
|
193
|
|
|
@@ -215,7 +215,7 @@ discard block |
|
|
block discarded – undo |
|
215
|
215
|
*/ |
|
216
|
216
|
private function setUserToBeImpersonated($actAs) |
|
217
|
217
|
{ |
|
218
|
|
- if (! empty($actAs)) { |
|
|
218
|
+ if (!empty($actAs)) { |
|
219
|
219
|
if (version_compare($this->laravel->version(), '5.2.0', '<')) { |
|
220
|
220
|
$userModel = config('auth.model'); |
|
221
|
221
|
$user = $userModel::find((int) $actAs); |
|
@@ -257,9 +257,9 @@ discard block |
|
|
block discarded – undo |
|
257
|
257
|
if (in_array($route->getName(), $allowedRoutes) || str_is($routePrefix, $route->getUri()) || in_array($middleware, $route->middleware())) { |
|
258
|
258
|
if ($this->isValidRoute($route) && $this->isRouteVisibleForDocumentation($route->getAction()['uses'])) { |
|
259
|
259
|
$parsedRoutes[] = $generator->processRoute($route, $bindings, $this->option('header'), $withResponse); |
|
260
|
|
- $this->info('Processed route: ['.implode(',', $route->getMethods()).'] '.$route->getUri()); |
|
|
260
|
+ $this->info('Processed route: [' . implode(',', $route->getMethods()) . '] ' . $route->getUri()); |
|
261
|
261
|
} else { |
|
262
|
|
- $this->warn('Skipping route: ['.implode(',', $route->getMethods()).'] '.$route->getUri()); |
|
|
262
|
+ $this->warn('Skipping route: [' . implode(',', $route->getMethods()) . '] ' . $route->getUri()); |
|
263
|
263
|
} |
|
264
|
264
|
} |
|
265
|
265
|
} |
|
@@ -284,9 +284,9 @@ discard block |
|
|
block discarded – undo |
|
284
|
284
|
if (empty($allowedRoutes) || in_array($route->getName(), $allowedRoutes) || str_is($routePrefix, $route->uri()) || in_array($middleware, $route->middleware())) { |
|
285
|
285
|
if ($this->isValidRoute($route) && $this->isRouteVisibleForDocumentation($route->getAction()['uses'])) { |
|
286
|
286
|
$parsedRoutes[] = $generator->processRoute($route, $bindings, $this->option('header'), $withResponse); |
|
287
|
|
- $this->info('Processed route: ['.implode(',', $route->getMethods()).'] '.$route->uri()); |
|
|
287
|
+ $this->info('Processed route: [' . implode(',', $route->getMethods()) . '] ' . $route->uri()); |
|
288
|
288
|
} else { |
|
289
|
|
- $this->warn('Skipping route: ['.implode(',', $route->getMethods()).'] '.$route->uri()); |
|
|
289
|
+ $this->warn('Skipping route: [' . implode(',', $route->getMethods()) . '] ' . $route->uri()); |
|
290
|
290
|
} |
|
291
|
291
|
} |
|
292
|
292
|
} |
|
@@ -301,7 +301,7 @@ discard block |
|
|
block discarded – undo |
|
301
|
301
|
*/ |
|
302
|
302
|
private function isValidRoute($route) |
|
303
|
303
|
{ |
|
304
|
|
- return ! is_callable($route->getAction()['uses']) && ! is_null($route->getAction()['uses']); |
|
|
304
|
+ return !is_callable($route->getAction()['uses']) && !is_null($route->getAction()['uses']); |
|
305
|
305
|
} |
|
306
|
306
|
|
|
307
|
307
|
/** |
|
@@ -318,7 +318,7 @@ discard block |
|
|
block discarded – undo |
|
318
|
318
|
$phpdoc = new DocBlock($comment); |
|
319
|
319
|
|
|
320
|
320
|
return collect($phpdoc->getTags()) |
|
321
|
|
- ->filter(function ($tag) use ($route) { |
|
|
321
|
+ ->filter(function($tag) use ($route) { |
|
322
|
322
|
return $tag->getName() === 'hideFromAPIDocumentation'; |
|
323
|
323
|
}) |
|
324
|
324
|
->isEmpty(); |