(v2.11) enabled

Author: kevincobain2000

README.md

@@ -61,7 +61,7 @@ Read more: https://medium.com/web-developer/laravel-automatically-generate-api-d
 You can install the package via composer:
 
 ```bash
-composer require rakutentech/laravel-request-docs --dev
+composer require rakutentech/laravel-request-docs
 ```
 
 
@@ -72,6 +72,18 @@ php artisan vendor:publish --tag=request-docs-config
 php artisan route:cache
 ```
 
+(optional) Add following middleware to your API, so that the sql logs, model events are captured.
+
+`app/Http/Kernel.php`
+
+```sh
+        'api' => [
+            ...
+            \Rakutentech\LaravelRequestDocs\LaravelRequestDocsMiddleware::class,
+            ... and so on
+
+```
+
 # Usage
 
 ## Dashboard

config/request-docs.php

@@ -1,6 +1,7 @@
 <?php
 
 return [
+    'enabled' => true,
     // change it to true will make lrd to throw exception if rules in request class need to be changed
     // keep it false
     'debug' => false,

phpstan.neon

@@ -13,7 +13,7 @@ parameters:
 #    ignoreErrors:
 #        - '#PHPDoc tag @var#'
 #
-#    excludePaths:
-#        - ./*/*/FileToBeExcluded.php
+    excludePaths:
+        - ./*/*/LaravelRequestDocsMiddleware.php
 
     checkMissingIterableValueType: false

src/LaravelRequestDocs.php

@@ -232,7 +232,11 @@ public function appendRequestRules(Collection $docs): Collection
                 try {
                     $requestClassName = $namedType->getName();
                     $reflectionClass  = new ReflectionClass($requestClassName);
-                    $requestObject    = $reflectionClass->newInstanceWithoutConstructor();
+                    try {
+                        $requestObject = $reflectionClass->newInstance();
+                    } catch (Throwable $th) {
+                        $requestObject = $reflectionClass->newInstanceWithoutConstructor();
+                    }
 
                     foreach (config('request-docs.rules_methods') as $requestMethod) {
                         if (!method_exists($requestObject, $requestMethod)) {

src/LaravelRequestDocsMiddleware.php

@@ -27,10 +27,27 @@ class LaravelRequestDocsMiddleware extends QueryLogger
      */
     public function handle(Request $request, Closure $next): Response
     {
-        if (!$request->headers->has('X-Request-LRD') || !config('app.debug')) {
+        if (!config('request-docs.enabled')) {
             return $next($request);
         }
 
+        if (!config('app.debug') && $request->headers->has('X-Request-LRD')) {
+            $response    = $next($request);
+            $jsonContent = json_encode([
+                'data' => $response->getData()
+            ]);
+            $response->setContent($jsonContent);
+            return $response;
+        }
+
+        if (!config('app.debug')) {
+            return $next($request);
+        }
+        if (!$request->headers->has('X-Request-LRD')) {
+            return $next($request);
+        }
+
+
         if (!config('request-docs.hide_sql_data')) {
             $this->listenToDB();
         }

src/LaravelRequestDocsServiceProvider.php

@@ -26,6 +26,9 @@ public function configurePackage(Package $package): void
     public function packageBooted()
     {
         parent::packageBooted();
+        if (!config('request-docs.enabled')) {
+            return;
+        }
 
         // URL from which the docs will be served.
         Route::get(config('request-docs.url'), [\Rakutentech\LaravelRequestDocs\Controllers\LaravelRequestDocsController::class, 'index'])

ui/src/components/App.tsx

@@ -28,7 +28,7 @@ export default function App() {
     const [showHead] = useLocalStorage('showHead', 'true');
 
     const searchOptions = {
-        keys: ['uri', 'docBlock'],
+        keys: ['uri', 'doc_block'],
         threshold: 0.3
     };
 

ui/src/components/elements/ApiActionInfo.tsx

@@ -19,10 +19,10 @@ export default function ApiActionInfo(props: Props) {
     return (
         <div className="mockup-window border">
             <div className="p-5">
-                {lrdDocsItem.docBlock && (
+                {lrdDocsItem.doc_block && (
                     <div className='text-sm mb-10 text-slate-500'>
                         {/*  eslint-disable-next-line react/no-children-prop */}
-                        <ReactMarkdown children={lrdDocsItem.docBlock} remarkPlugins={[remarkGfm]} />
+                        <ReactMarkdown children={lrdDocsItem.doc_block} remarkPlugins={[remarkGfm]} />
                     </div>
                 )}
                 <table className="table table-fixed table-compact">

ui/src/libs/types.tsx

@@ -10,7 +10,7 @@ export interface IAPIInfo {
     method: string;
     http_method: string;
     rules: IAPIRule;
-    docBlock: string;
+    doc_block: string;
     group: string;
     group_index: number;
     responses: string[];