alpha

Author: kevincobain2000

README.md

@@ -1,6 +1,6 @@
 # Laravel Docs Generator
 
-Automatically generate docs from request Rules
+Automatically generate api documentation for Laravel without writing annotations.
 
 
 ## Requirements
@@ -22,23 +22,38 @@ composer require rakutentech/laravel-request-docs --dev
 You can publish the config file with:
 
 ```bash
-php artisan vendor:publish --provider="Rakutentech\LaravelRequestDocs\LaravelRequestDocsServiceProvider"
+php artisan vendor:publish --tag=request-docs-config
 ```
 
 ## Usage
 
+View in the browser on ``/request-docs/``
+
+or generate a static HTML
+
 ```php
-php artisan laravel-request-docs
+php artisan lrd:generate
 ```
 
 Docs HTML is generated inside ``docs/``.
 
-### Sample
+## Design pattern
+
+In order for this plugin to work, you need to follow the design pattern by injecting the request class inside the controller.
+For extra documentation you can use markdown inside your controller method as well.
+
+![Design pattern](https://imgur.com/yXjq3jp.png)
+
+### Screenshots
 
-#### Screenshot
+Generated API documentation
 
+![Preview](https://imgur.com/8DvBBhs.png)
+
+Try API
+
+![Preview](https://imgur.com/kcKVSzm.png)
 
-#### Get JSON output
 
 ## Testing
 
@@ -48,9 +63,5 @@ Docs HTML is generated inside ``docs/``.
 
 ## Changelog
 
-- Initial Release - POC
-
-
-## TODO
+- Initial Release
 
-- Support Swagger

config/request-docs.php

@@ -14,13 +14,6 @@
  * Path to to static HTML if using command line.
  */
  'docs_path' => base_path('docs/request-docs/'),
- 'swagger' => [
- /*
- * https://github.com/DarkaOnLine/L5-Swagger
- * File name of the generated json documentation file by Laravel swagger
- */
- 'docs_json_path' => storage_path('api-docs/api-docs.json') // change it to null to disable
- ],
  'hide_matching' => [
  "#^telescope#",
  "#^docs#",

resources/views/index.blade.php

@@ -399,6 +399,7 @@ class="my-prism-editor"
  doc.loading = true
  axios.defaults.headers.common['X-Request-LRD'] = 'lrd'
  axios.defaults.headers.common['X-CSRF-TOKEN'] = '{{ csrf_token() }}'
+
  axios({
  method: method,
  url: url,

src/Commands/LaravelRequestDocsCommand.php

@@ -4,22 +4,20 @@
 
 use Illuminate\Console\Command;
 use Rakutentech\LaravelRequestDocs\LaravelRequestDocs;
-use Rakutentech\LaravelRequestDocs\LaravelRequestSwaggerDocs;
+
 use File;
 
 class LaravelRequestDocsCommand extends Command
 {
  public $signature = 'lrd:generate';
 
- public $description = 'Generate request docs to HTML and update swagger json';
+ public $description = 'Generate request docs to HTML';
 
  private $laravelRequestDocs;
- private $laravelRequestSwaggerDocs;
 
- public function __construct(LaravelRequestDocs $laravelRequestDocs, LaravelRequestSwaggerDocs $laravelRequestSwaggerDocs)
+ public function __construct(LaravelRequestDocs $laravelRequestDocs)
  {
- $this->laravelRequestDocs = $laravelRequestDocs;
- $this->laravelRequestSwaggerDocs = $laravelRequestSwaggerDocs;
+ $this->laravelRequestDocs = $laravelRequestDocs;
  parent::__construct();
  }
 

src/Commands/LaravelRequestDocsSwaggerCommand.php

@@ -7,6 +7,7 @@
 use Illuminate\Http\Request;
 use Illuminate\Foundation\Http\FormRequest;
 use Illuminate\Support\Str;
+use Exception;
 class LaravelRequestDocs
 {
 
@@ -67,15 +68,19 @@ public function getControllersInfo(): Array
  $controllersInfo = [];
  $routes = collect(Route::getRoutes());
  foreach ($routes as $route) {
- $controllersInfo[] = [
- 'uri' => $route->uri,
- 'methods' => $route->methods,
- 'middlewares' => !is_array($route->action['middleware']) ? [$route->action['middleware']] : $route->action['middleware'],
- 'controller' => explode('@', $route->action['controller'])[0],
- 'method' => explode('@', $route->action['controller'])[1],
- 'rules' => [],
- 'docBlock' => "",
- ];
+ try {
+ $controllersInfo[] = [
+ 'uri' => $route->uri,
+ 'methods' => $route->methods,
+ 'middlewares' => !is_array($route->action['middleware']) ? [$route->action['middleware']] : $route->action['middleware'],
+ 'controller' => explode('@', $route->action['controller'])[0],
+ 'method' => explode('@', $route->action['controller'])[1],
+ 'rules' => [],
+ 'docBlock' => "",
+ ];
+ } catch (Exception $e) {
+ continue;
+ }
  }
 
  return $controllersInfo;
@@ -109,7 +114,7 @@ public function appendRequestRules(Array $controllersInfo)
  return $controllersInfo;
  }
 
- public function lrdDocComment(bool|string $docComment): string
+ public function lrdDocComment($docComment): string
  {
  $lrdComment = "";
  $counter = 0;

src/LaravelRequestDocs.php

@@ -5,7 +5,6 @@
 use Spatie\LaravelPackageTools\Package;
 use Spatie\LaravelPackageTools\PackageServiceProvider;
 use Rakutentech\LaravelRequestDocs\Commands\LaravelRequestDocsCommand;
-use Rakutentech\LaravelRequestDocs\Commands\LaravelRequestDocsSwaggerCommand;
 use Route;
 
 class LaravelRequestDocsServiceProvider extends PackageServiceProvider
@@ -22,8 +21,7 @@ public function configurePackage(Package $package): void
  ->hasConfigFile('request-docs')
  ->hasViews()
  //->hasAssets()
- ->hasCommand(LaravelRequestDocsCommand::class)
- ->hasCommand(LaravelRequestDocsSwaggerCommand::class);
+ ->hasCommand(LaravelRequestDocsCommand::class);
 
  Route::get(config('request-docs.url'), [\Rakutentech\LaravelRequestDocs\Controllers\LaravelRequestDocsController::class, 'index'])
  ->name('request-docs.index')