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::swagger-error',
     ],
 
     /*
@@ -184,5 +193,5 @@
         'development',
     ],
 
-    'config_version' => '2.8',
+    'config_version' => '2.9',
 ];

resources/views/swagger-error.blade.php

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

src/AutoDocServiceProvider.php

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

src/Drivers/LocalDriver.php

@@ -30,7 +30,7 @@ public function saveData(): void
     public function getDocumentation(): array
     {
         if (!file_exists($this->prodFilePath)) {
-            throw new FileNotFoundException();
+            throw new FileNotFoundException("Documentation file not found :{$this->prodFilePath}");
         }
 
         $fileContent = file_get_contents($this->prodFilePath);

src/Drivers/RemoteDriver.php

@@ -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

@@ -34,7 +34,7 @@ public function saveData(): void
     public function getDocumentation(): array
     {
         if (!$this->disk->exists($this->prodFilePath)) {
-            throw new FileNotFoundException();
+            throw new FileNotFoundException("Documentation file not found :{$this->prodFilePath}");
         }
 
         $fileContent = $this->disk->get($this->prodFilePath);

src/Services/SwaggerService.php

@@ -138,7 +138,21 @@ protected function generateEmptyData(): array
             throw new EmptyContactEmailException();
         }
 
-        $data = [
+        $data = $this->generateBaseDataObject();
+        $data['info'] = $this->prepareInfo($this->config['info']);
+
+        $securityDefinitions = $this->generateSecurityDefinition();
+
+        if (!empty($securityDefinitions)) {
+            $data['securityDefinitions'] = $securityDefinitions;
+        }
+
+        return $data;
+    }
+
+    protected function generateBaseDataObject(): array
+    {
+        return [
             'openapi' => self::OPEN_API_VERSION,
             'servers' => [
                 ['url' => URL::query($this->config['basePath'])],
@@ -147,16 +161,7 @@ protected function generateEmptyData(): array
             'components' => [
                 'schemas' => $this->config['definitions'],
             ],
-            'info' => $this->prepareInfo($this->config['info'])
         ];
-
-        $securityDefinitions = $this->generateSecurityDefinition();
-
-        if (!empty($securityDefinitions)) {
-            $data['securityDefinitions'] = $securityDefinitions;
-        }
-
-        return $data;
     }
 
     protected function generateSecurityDefinition(): ?array
@@ -804,9 +809,19 @@ public function saveProductionData()
 
     public function getDocFileContent()
     {
-        $documentation = $this->driver->getDocumentation();
+        try {
+            $documentation = $this->driver->getDocumentation();
+
+            $this->openAPIValidator->validate($documentation);
+        } catch (\Exception $exception) {
+            $data = $this->generateBaseDataObject();
 
-        $this->openAPIValidator->validate($documentation);
+            $this->config['info'] = Arr::set($this->config, 'info.description', Arr::get($this->config, 'defaults.error'));
+
+            $data['info'] = $this->prepareInfo($this->config['info'], ['message' => $exception->getMessage()]);
+
+            return $data;
+        }
 
         $additionalDocs = config('auto-doc.additional_paths', []);
 
@@ -931,7 +946,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;
@@ -948,7 +963,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;