Merge pull request rakutentech#29 from JustRaviga/fork

Add ability to generate docs only for specific route uri prefix

Author: kevincobain2000

config/request-docs.php

@@ -22,6 +22,9 @@
  */
  'sort_by' => 'default',
 
+ //Use only routes where ->uri start with next string Using Str::startWith( . e.g. - /api/mobile
+ 'only_route_uri_start_with' => '',
+
  'hide_matching' => [
  "#^telescope#",
  "#^docs#",

src/LaravelRequestDocs.php

@@ -2,12 +2,14 @@
 
 namespace Rakutentech\LaravelRequestDocs;
 
+use ErrorException;
 use Route;
 use ReflectionMethod;
 use Illuminate\Http\Request;
 use Illuminate\Foundation\Http\FormRequest;
 use Illuminate\Support\Str;
 use Exception;
+use Throwable;
 
 class LaravelRequestDocs
 {
@@ -76,7 +78,13 @@ public function getControllersInfo(): array
  {
  $controllersInfo = [];
  $routes = collect(Route::getRoutes());
+ $onlyRouteStartWith = config('request-docs.only_route_uri_start_with') ?? '';
+
  foreach ($routes as $route) {
+ if($onlyRouteStartWith && !Str::startsWith($route->uri, $onlyRouteStartWith)){
+ continue;
+ }
+
  try {
  /// Show Pnly Controller Name
  $controllerFullPath = explode('@', $route->action['controller'])[0];
@@ -121,13 +129,13 @@ public function appendRequestRules(array $controllersInfo)
  $requestClass = null;
  try {
  $requestClass = new $requestClassName();
- } catch (\Throwable $th) {
+ } catch (Throwable $th) {
  //throw $th;
  }
  if ($requestClass instanceof FormRequest) {
  try {
  $controllersInfo[$index]['rules'] = $this->flattenRules($requestClass->rules());
- } catch (\ErrorException $th) {
+ } catch (ErrorException $th) {
  $controllerInfo[$index]['rules'] = $this->rulesByRegex($requestClassName);
  }
  $controllersInfo[$index]['docBlock'] = $this->lrdDocComment($reflectionMethod->getDocComment());