add base response success

Author: astral-data

.openapi.php

@@ -49,9 +49,16 @@
      * You can override or extend this list in your config file.
      */
     'exclude_dirs' => [],
+
+    /**
+     * Response Data Structure Definition
+     *
+     * Defines the basic structure of API responses, including status code, return message, and data body
+     *
+     */
     'response' => [
-        'code' => '状态码',
-        'message' => '返回信息',
-        'data' => 'object',
+        'code' => ['description' =>'状态码', 'example'=> 200],
+        'message' => ['description' =>'返回信息', 'example'=> '操作成功'],
+        'data' => 'T',
     ]
 ];

src/OpenApi/Storage/OpenAPI/ResponseStorage.php

@@ -30,19 +30,19 @@ public function addGlobParameters(array $vols): void
 
         $this->parameter['properties'] = [];
 
-        foreach ($vols as $field => $description){
-            if($description !== 'object'){
-                $this->parameter['properties'][$field] = [
-                    'type'        => 'string',
-                    'description' => $description,
-                ];
-            }else{
+        foreach ($vols as $field => $item){
+            if($item === 'T'){
                 $this->parameter['properties'][$field] = [
                     'type'        => 'object',
-                    'description' => $description,
                     'properties' => $dates,
                     'required' => $required,
                 ];
+            }else{
+                $this->parameter['properties'][$field] = [
+                    'type'        => 'string',
+                    'description' => $item['description'] ?? '',
+                    'example'     => $item['example'],
+                ];
             }
 
         }

src/Serialize.php

@@ -2,10 +2,12 @@
 
 namespace Astral\Serialize;
 
+use Astral\Serialize\OpenApi\Handler\Config;
 use Astral\Serialize\Support\Context\SerializeContext;
 use Astral\Serialize\Support\Factories\ContextFactory;
+use JsonSerializable;
 
-abstract class Serialize
+abstract class Serialize implements JsonSerializable
 {
     private ?SerializeContext $_context = null;
 
@@ -71,4 +73,22 @@ public function __debugInfo()
 
         return $res;
     }
+
+    public function jsonSerialize(): array
+    {
+        $baseResponse = Config::get('response',[]);
+        if($baseResponse){
+            $resultData = [];
+            foreach ($baseResponse as $field => $item){
+                if($item === 'T'){
+                    $resultData[$field] = $this->toArray();
+                }else{
+                    $resultData[$field] = $item['example'] ?? '';
+                }
+            }
+            return $resultData;
+        }
+
+        return $this->toArray();
+    }
 }