Modify 500 code error response page

config/auto-doc.php

@@ -101,6 +101,15 @@
             '204' => 'Operation successfully done',
             '404' => 'This entity not found',
         ],
+
+        /*
+        |--------------------------------------------------------------------------
+        | Error Template
+        |--------------------------------------------------------------------------
+        |
+        | You can use your custom description view for errors.
+        */
+        'error' => 'auto-doc::error',
     ],
 
     /*
@@ -211,5 +220,5 @@
         ],
     ],
 
-    'config_version' => '2.9',
+    'config_version' => '2.10',
 ];

resources/views/error.blade.php

@@ -0,0 +1 @@
+{{ $message }}

src/AutoDocServiceProvider.php

@@ -17,6 +17,7 @@ public function boot()
 
         $this->publishes([
             __DIR__ . '/../resources/views/swagger-description.blade.php' => resource_path('views/vendor/auto-doc/swagger-description.blade.php'),
+            __DIR__ . '/../resources/views/error.blade.php' => resource_path('views/vendor/auto-doc/error.blade.php'),
         ], 'view');
 
         if (!$this->app->routesAreCached()) {

src/Drivers/LocalDriver.php

@@ -2,7 +2,7 @@
 
 namespace RonasIT\AutoDoc\Drivers;
 
-use Illuminate\Contracts\Filesystem\FileNotFoundException;
+use RonasIT\AutoDoc\Exceptions\FileNotFoundException;
 use RonasIT\AutoDoc\Exceptions\MissedProductionFilePathException;
 
 class LocalDriver extends BaseDriver
@@ -30,7 +30,7 @@ public function saveData(): void
     public function getDocumentation(): array
     {
         if (!file_exists($this->prodFilePath)) {
-            throw new FileNotFoundException();
+            throw new FileNotFoundException($this->prodFilePath);
         }
 
         $fileContent = file_get_contents($this->prodFilePath);

src/Drivers/RemoteDriver.php

@@ -2,7 +2,7 @@
 
 namespace RonasIT\AutoDoc\Drivers;
 
-use Illuminate\Contracts\Filesystem\FileNotFoundException;
+use RonasIT\AutoDoc\Exceptions\FileNotFoundException;
 use RonasIT\AutoDoc\Exceptions\MissedRemoteDocumentationUrlException;
 
 class RemoteDriver extends BaseDriver
@@ -36,7 +36,7 @@ public function getDocumentation(): array
         list($content, $statusCode) = $this->makeHttpRequest('get', $this->getUrl());
 
         if (empty($content) || $statusCode !== 200) {
-            throw new FileNotFoundException();
+            throw new FileNotFoundException('Documentation file not found.');
         }
 
         return json_decode($content, true);

src/Drivers/StorageDriver.php

@@ -2,7 +2,7 @@
 
 namespace RonasIT\AutoDoc\Drivers;
 
-use Illuminate\Contracts\Filesystem\FileNotFoundException;
+use RonasIT\AutoDoc\Exceptions\FileNotFoundException;
 use Illuminate\Contracts\Filesystem\Filesystem;
 use Illuminate\Support\Facades\Storage;
 use RonasIT\AutoDoc\Exceptions\MissedProductionFilePathException;
@@ -34,7 +34,7 @@ public function saveData(): void
     public function getDocumentation(): array
     {
         if (!$this->disk->exists($this->prodFilePath)) {
-            throw new FileNotFoundException();
+            throw new FileNotFoundException($this->prodFilePath);
         }
 
         $fileContent = $this->disk->get($this->prodFilePath);

src/Exceptions/FileNotFoundException.php

@@ -0,0 +1,17 @@
+<?php
+
+namespace RonasIT\AutoDoc\Exceptions;
+
+use \Illuminate\Contracts\Filesystem\FileNotFoundException as BaseException;
+
+class FileNotFoundException extends BaseException
+{
+    public function __construct(string $filePath = null)
+    {
+        $message = empty($filePath)
+            ? 'Documentation file not found'
+            : "Documentation file not found: {$filePath}";
+
+        parent::__construct($message);
+    }
+}

src/Services/SwaggerService.php

@@ -23,6 +23,7 @@
 use RonasIT\AutoDoc\Traits\GetDependenciesTrait;
 use RonasIT\AutoDoc\Validators\SwaggerSpecValidator;
 use Symfony\Component\HttpFoundation\Response;
+use Exception;
 
 /**
  * @property SwaggerDriverContract $driver
@@ -131,8 +132,11 @@ protected function setDriver()
         }
     }
 
-    protected function generateEmptyData(): array
+    protected function generateEmptyData(array $info = [], $decriptionData = []): array
     {
+        if(empty($info)){
+            $info = $this->config['info'];
+        }
         // client must enter at least `contact.email` to generate a default `info` block
         // otherwise an exception will be called
         if (!empty($this->config['info']) && !Arr::get($this->config, 'info.contact.email')) {
@@ -148,7 +152,7 @@ protected function generateEmptyData(): array
             'components' => [
                 'schemas' => $this->config['definitions'],
             ],
-            'info' => $this->prepareInfo($this->config['info'])
+            'info' => $this->prepareInfo($info, $decriptionData),
         ];
 
         $securityDefinitions = $this->generateSecurityDefinition();
@@ -160,6 +164,20 @@ protected function generateEmptyData(): array
         return $data;
     }
 
+    protected function generateBaseDataObject(): array
+    {
+        return [
+            'openapi' => self::OPEN_API_VERSION,
+            'servers' => [
+                ['url' => URL::query($this->config['basePath'])],
+            ],
+            'paths' => [],
+            'components' => [
+                'schemas' => $this->config['definitions'],
+            ],
+        ];
+    }
+
     protected function generateSecurityDefinition(): ?array
     {
         if (empty($this->security)) {
@@ -817,9 +835,16 @@ public function saveProductionData()
 
     public function getDocFileContent()
     {
-        $documentation = $this->driver->getDocumentation();
+        try {
+            $documentation = $this->driver->getDocumentation();
 
-        $this->openAPIValidator->validate($documentation);
+            $this->openAPIValidator->validate($documentation);
+        } catch (Exception $exception) {
+            $infoConfig = $this->config['info'];
+            $infoConfig['description'] = Arr::get($this->config, 'defaults.error');
+
+            return $this->generateEmptyData($infoConfig, ['message' => $exception->getMessage()]);
+        }
 
         $additionalDocs = config('auto-doc.additional_paths', []);
 
@@ -946,7 +971,7 @@ protected function getDefaultValueByType($type)
         return $values[$type];
     }
 
-    protected function prepareInfo(array $info): array
+    protected function prepareInfo(array $info, array $descriptionData = []): array
     {
         if (empty($info)) {
             return $info;
@@ -963,7 +988,7 @@ protected function prepareInfo(array $info): array
         }
 
         if (!empty($info['description'])) {
-            $info['description'] = view($info['description'])->render();
+            $info['description'] = view($info['description'], $descriptionData)->render();
         }
 
         return $info;