PHP Class Mpociot\ApiDoc\Commands\GenerateDocumentation

Inheritance: extends Illuminate\Console\Command
Show file Open project: mpociot/laravel-apidoc-generator

Protected Properties

Property Type Description
$description string The console command description.
$signature string The name and signature of the console command.

Public Methods

Method Description
__construct ( ) : void Create a new command instance.
handle ( ) : false | null Execute the console command.

Private Methods

Method Description
generatePostmanCollection ( Collection $routes ) : string Generate Postman collection JSON file.
getBindings ( ) : array
getRoutes ( ) : mixed
isRouteVisibleForDocumentation ( $route ) : boolean
isValidRoute ( $route ) : boolean
processDingoRoutes ( AbstractGenerator $generator, $allowedRoutes, $routePrefix, $middleware ) : array
processLaravelRoutes ( AbstractGenerator $generator, $allowedRoutes, $routePrefix, $middleware ) : array
setUserToBeImpersonated ( $actAs )
writeMarkdown ( Collection $parsedRoutes ) : void

Method Details

__construct() public method

Create a new command instance.
public __construct ( ) : void
return void

handle() public method

Execute the console command.
public handle ( ) : false | null
return false | null

Property Details

$description protected property

The console command description.
protected string $description
return string

$signature protected property

The name and signature of the console command.
protected string $signature
return string