Pārlūkot izejas kodu

Add custom logo support

Thomas van der Beek 6 gadi atpakaļ
vecāks
revīzija
2862e05eb7
2 mainītis faili ar 20 papildinājumiem un 0 dzēšanām
  1. 12 0
      config/apidoc.php
  2. 8 0
      src/Commands/GenerateDocumentation.php

+ 12 - 0
config/apidoc.php

@@ -87,4 +87,16 @@ return [
             ],
         ],
     ],
+
+    /**
+     * Custom logo path. Will be copied during generate command.
+     *
+     * If you want to use this, please be aware of the following rules:
+     * - filename: logo.png
+     * - size: 230 x 52
+     *
+     * Change false to an absolute path. For example:
+     * 'logo' => resource_path('views') . '/api/logo.png'
+     */
+    'logo' => false
 ];

+ 8 - 0
src/Commands/GenerateDocumentation.php

@@ -7,6 +7,7 @@ use Illuminate\Routing\Route;
 use Illuminate\Console\Command;
 use Mpociot\Reflection\DocBlock;
 use Illuminate\Support\Collection;
+use Illuminate\Support\Facades\Storage;
 use Mpociot\ApiDoc\Tools\RouteMatcher;
 use Mpociot\Documentarian\Documentarian;
 use Mpociot\ApiDoc\Postman\CollectionWriter;
@@ -172,6 +173,13 @@ class GenerateDocumentation extends Command
 
             file_put_contents($outputPath.DIRECTORY_SEPARATOR.'collection.json', $this->generatePostmanCollection($parsedRoutes));
         }
+
+        if ($logo = config('apidoc.logo')) {
+            Storage::copy(
+                $logo,
+                $outputPath.DIRECTORY_SEPARATOR.'images'.DIRECTORY_SEPARATOR.'logo.png'
+            );
+        }
     }
 
     /**