add config

Author: astral-data

.openapi.php

@@ -1,12 +1,23 @@
 <?php
 
+use Astral\Serialize\OpenApi\Storage\OpenAPI\ServersStorage;
+
 return [
     'title' => 'API Docs',
+
     'description' => 'API Docs description.',
+
+    /**
+     * 向全局头部参数存储中添加一个的头部参数。
+     * @param string $name
+     * @param string $example
+     * @param string $description
+     */
     'headers' => [
 
     ],
-    'service' => [
 
+    'service' => [
+        new ServersStorage('http://127.0.0.1','默认环境'),
     ],
 ];

src/OpenApi.php

@@ -53,7 +53,6 @@ public function buildByClass(string $className): void
                 Headers::class     => null,
             ];
 
-
             foreach ($methodAttributes as $methodAttribute) {
                 $inst =  $methodAttribute->newInstance();
                 foreach (array_keys($instances) as $anchorClass) {
@@ -63,7 +62,6 @@ public function buildByClass(string $className): void
                 }
             }
 
-
             if ($instances[Route::class] === null || $instances[Summary::class] === null) {
                 continue;
             }

src/OpenApi/Handler/Config.php

@@ -15,8 +15,7 @@
 
 class Config
 {
-
-    public static $config;
+    public static array $config;
 
     public static function rootPath(): string
     {
@@ -29,12 +28,11 @@ public static function build()
             return self::$config;
         }
 
+        self::$config = include dirname(__DIR__, 3).'/.openapi.php';
+
         $path = self::rootPath().'/.openapi.php';
         if(is_file($path)){
-            self::$config = include $path;
-        }
-        else{
-            self::$config = include dirname(__DIR__, 3).'/.openapi.php';
+            self::$config = array_merge(self::$config,include $path);
         }
 
         return self::$config;
@@ -45,4 +43,9 @@ public static function get($key)
         return self::build()[$key] ?? '';
     }
 
+    public static function has($key): bool
+    {
+        return isset(self::build()[$key]);
+    }
+
 }

src/OpenApi/Handler/HandleInterface.php

@@ -6,7 +6,6 @@
 
 interface HandleInterface
 {
-    public function output(string $path): bool;
 
     public function toString(): string;
 }

src/OpenApi/Handler/Handler.php

@@ -15,13 +15,22 @@
 
 abstract class Handler implements HandleInterface
 {
-    /** @var OpenAPI */
-    public static OpenAPI $OpenAPI;
+    /** @var OpenAPI|null */
+    public static ?OpenAPI $OpenAPI = null;
 
     public function __construct(
         protected readonly ParameterStorage $headerParameterStorages = new ParameterStorage()
     ) {
-        self::$OpenAPI ??= (new OpenAPI())->withApiInfo(new ApiInfo('API Doc',''));
+
+        self::$OpenAPI ??= (new OpenAPI())
+            ->withApiInfo(new ApiInfo(Config::get('title'), Config::get('description')))
+            ->withServers(Config::get('service'));
+
+        if(Config::has('headers')) {
+            foreach (Config::get('headers') as $header) {
+                $this->headerParameterStorages->addHeaderProperties($header['name'], $header['description'], $header['example']);
+            }
+        }
     }
 
     public function rootPath(): string
@@ -114,7 +123,6 @@ protected function scanFolderRecursively(string $folder, string $namespace): voi
 
             // 如果是子目录，则递归，并拼接命名空间
             if (is_dir($path)) {
-
                 // 例如，如果当前命名空间是 "App"：
                 // 子目录 "Http" 则新的命名空间为 "App\Http"
                 $newNamespace = $namespace !== '' ? ($namespace . '\\' . $file) : $file;
@@ -152,11 +160,6 @@ protected function scanFolderRecursively(string $folder, string $namespace): voi
         }
     }
 
-    public function output(string $path): bool
-    {
-        return true;
-    }
-
     /**
      * @throws JsonException
      */

src/OpenApi/Storage/OpenAPI/OpenAPI.php

@@ -10,7 +10,6 @@
 
 class OpenAPI implements StorageInterface
 {
-
     public string $openapi = '3.1.1';
 
     public ApiInfo $info;
@@ -34,6 +33,7 @@ public function withApiInfo(ApiInfo $apiInfo): self
         return $this;
     }
 
+
     public function withServers(array $servers): self
     {
         $this->servers = $servers;

src/OpenApi/Storage/OpenAPI/ServersStorage.php

@@ -12,8 +12,17 @@ class ServersStorage implements StorageInterface
     public function __construct(
         public string $url,
         public string $description,
-        public array|stdClass|null $variables = null
+        public array|stdClass $variables = new stdClass(),
     ) {
-        $this->variables = $this->variables ?: new stdClass();
+
+    }
+
+    public function addVariable(string $name, $description, $default = ''): static
+    {
+        $this->variables  = $this->variables instanceof stdClass::class ? [] : $this->variables;
+
+        $this->variables[$name] = ['default' => $default, 'description'=> $description];
+
+        return $this;
     }
 }