Merge pull request #81 from RonasIT/45_fix_exception_when_setting_invalid_additional_path

#45: Check file existence when parsing additional doc files

Author: DenTray

src/Services/SwaggerService.php

@@ -648,32 +648,36 @@ public function getDocFileContent()
         $additionalDocs = config('auto-doc.additional_paths', []);
 
         foreach ($additionalDocs as $filePath) {
-            $fileContent = json_decode(file_get_contents(base_path($filePath)), true);
+            $fullFilePath = base_path($filePath);
 
-            $paths = array_keys($fileContent['paths']);
+            if (file_exists($fullFilePath)) {
+                $fileContent = json_decode(file_get_contents($fullFilePath), true);
 
-            foreach ($paths as $path) {
-                $additionalDocPath = $fileContent['paths'][$path];
+                $paths = array_keys($fileContent['paths']);
 
-                if (empty($documentation['paths'][$path])) {
-                    $documentation['paths'][$path] = $additionalDocPath;
-                } else {
-                    $methods = array_keys($documentation['paths'][$path]);
-                    $additionalDocMethods = array_keys($additionalDocPath);
+                foreach ($paths as $path) {
+                    $additionalDocPath = $fileContent['paths'][$path];
 
-                    foreach ($additionalDocMethods as $method) {
-                        if (!in_array($method, $methods)) {
-                            $documentation['paths'][$path][$method] = $additionalDocPath[$method];
+                    if (empty($documentation['paths'][$path])) {
+                        $documentation['paths'][$path] = $additionalDocPath;
+                    } else {
+                        $methods = array_keys($documentation['paths'][$path]);
+                        $additionalDocMethods = array_keys($additionalDocPath);
+
+                        foreach ($additionalDocMethods as $method) {
+                            if (!in_array($method, $methods)) {
+                                $documentation['paths'][$path][$method] = $additionalDocPath[$method];
+                            }
                         }
                     }
                 }
-            }
 
-            $definitions = array_keys($fileContent['definitions']);
+                $definitions = array_keys($fileContent['definitions']);
 
-            foreach ($definitions as $definition) {
-                if (empty($documentation['definitions'][$definition])) {
-                    $documentation['definitions'][$definition] = $fileContent['definitions'][$definition];
+                foreach ($definitions as $definition) {
+                    if (empty($documentation['definitions'][$definition])) {
+                        $documentation['definitions'][$definition] = $fileContent['definitions'][$definition];
+                    }
                 }
             }
         }

tests/AutoDocControllerTest.php

@@ -50,6 +50,19 @@ public function testGetJSONDocumentationWithAdditionalPaths()
         $this->assertEqualsJsonFixture('tmp_data_with_additional_paths', $response->json());
     }
 
+    public function testGetJSONDocumentationWithInvalidAdditionalPath()
+    {
+        config([
+            'auto-doc.additional_paths' => ['invalid_path/non_existent_file.json']
+        ]);
+
+        $response = $this->json('get', '/auto-doc/documentation');
+
+        $response->assertStatus(Response::HTTP_OK);
+
+        $response->assertJson($this->documentation);
+    }
+
     public function testGetJSONDocumentationWithGlobalPrefix()
     {
         $this->addGlobalPrefix();