fix swagger

lphkxd · lphkxd · commit 6ecb436fc53c · 2022-08-11T10:29:08.000+08:00
diff --git a/src/Annotation/ApiDefinition.php b/src/Annotation/ApiDefinition.php
@@ -3,6 +3,7 @@
 
 namespace HPlus\Swagger\Annotation;
 
+use Attribute;
 use Hyperf\Di\Annotation\AbstractAnnotation;
 /**
  * @Annotation
diff --git a/src/Annotation/ApiDefinitions.php b/src/Annotation/ApiDefinitions.php
@@ -3,6 +3,7 @@
 
 namespace HPlus\Swagger\Annotation;
 
+use Attribute;
 use Hyperf\Di\Annotation\AbstractAnnotation;
 /**
  * @Annotation
diff --git a/src/Annotation/ApiServer.php b/src/Annotation/ApiServer.php
@@ -2,6 +2,7 @@
 declare(strict_types=1);
 namespace HPlus\Swagger\Annotation;
 
+use Attribute;
 use Hyperf\Di\Annotation\AbstractAnnotation;
 /**
  * @Annotation
diff --git a/src/Annotation/ApiVersion.php b/src/Annotation/ApiVersion.php
@@ -2,6 +2,7 @@
 declare(strict_types=1);
 namespace HPlus\Swagger\Annotation;
 
+use Attribute;
 use Hyperf\Di\Annotation\AbstractAnnotation;
 
 /**
diff --git a/src/ApiAnnotation.php b/src/ApiAnnotation.php
@@ -2,17 +2,16 @@
 declare(strict_types=1);
 namespace HPlus\Swagger;
 
-use Doctrine\Common\Annotations\AnnotationReader;
 use Hyperf\Di\Annotation\AnnotationCollector;
+use Hyperf\Di\Annotation\AnnotationReader;
 use Hyperf\Di\ReflectionManager;
 
 class ApiAnnotation
 {
     public static function methodMetadata($className, $methodName)
     {
         $reflectMethod = ReflectionManager::reflectMethod($className, $methodName);
-        $reader = new AnnotationReader();
-
+        $reader = new AnnotationReader(config('annotations.scan.ignore_annotations', []));
         return $reader->getMethodAnnotations($reflectMethod);
     }
 
diff --git a/src/BootAppConfListener.php b/src/BootAppConfListener.php
@@ -22,7 +22,7 @@ public function listen(): array
         ];
     }
 
-    public function process(object $event)
+    public function process(object $event):void
     {
         $container = ApplicationContext::getContainer();
         $logger = $container->get(LoggerFactory::class)->get('swagger');
@@ -52,10 +52,13 @@ public function process(object $event)
             $ignore = $config->get('swagger.ignore', function ($controller, $action) {
                 return false;
             });
-
             array_walk_recursive($data, function ($item) use ($swagger, $ignore) {
                 if ($item instanceof Handler && !($item->callback instanceof \Closure)) {
                     [$controller, $action] = $this->prepareHandler($item->callback);
+
+
+
+
                     (!$ignore($controller, $action)) && $swagger->addPath($controller, $action, $item->route);
                 }
             });
diff --git a/src/Swagger/SwaggerJson.php b/src/Swagger/SwaggerJson.php
@@ -3,9 +3,11 @@
 
 namespace HPlus\Swagger\Swagger;
 
-use Doctrine\Common\Annotations\AnnotationReader;
+use Exception;
 use HPlus\Route\Annotation\ApiController;
 use HPlus\Route\Annotation\AdminController;
+use HPlus\Route\Annotation\GetApi;
+use HPlus\Route\Annotation\Mapping;
 use HPlus\Route\Annotation\Query;
 use HPlus\Swagger\Annotation\ApiDefinition;
 use HPlus\Swagger\Annotation\ApiDefinitions;
@@ -18,7 +20,6 @@
 use HPlus\Swagger\ApiAnnotation;
 use Hyperf\Contract\ConfigInterface;
 use Hyperf\Di\ReflectionManager;
-use Hyperf\HttpServer\Annotation\Mapping;
 use Hyperf\Utils\ApplicationContext;
 use Hyperf\Utils\Arr;
 use Hyperf\Utils\Str;
@@ -42,10 +43,7 @@ public function __construct($server)
 
     public function addPath($className, $methodName, $path)
     {
-        $ignores = $this->config->get('annotations.scan.ignore_annotations', []);
-        foreach ($ignores as $ignore) {
-            AnnotationReader::addGlobalIgnoredName($ignore);
-        }
+
         $classAnnotation = ApiAnnotation::classMetadata($className);
         $controlerAnno = $classAnnotation[ApiController::class] ?? $classAnnotation[AdminController::class] ?? null;
         $serverAnno = $classAnnotation[ApiServer::class] ?? null;
@@ -56,19 +54,20 @@ public function addPath($className, $methodName, $path)
         $servers = $this->config->get('server.servers');
         $servers_name = array_column($servers, 'name');
         if (!in_array($bindServer, $servers_name)) {
-            throw new \Exception(sprintf('The bind ApiServer name [%s] not found, defined in %s!', $bindServer, $className));
+            throw new Exception(sprintf('The bind ApiServer name [%s] not found, defined in %s!', $bindServer, $className));
         }
 
         if ($bindServer !== $this->server) {
             return;
         }
+
         $methodAnnotations = ApiAnnotation::methodMetadata($className, $methodName);
         if (!$controlerAnno || !$methodAnnotations) {
             return;
         }
         $params = [];
         $responses = [];
-        /** @var \HPlus\Route\Annotation\GetApi $mapping */
+        /** @var GetApi $mapping */
         $mapping = null;
         $consumes = null;
         $rules = [];
@@ -77,7 +76,7 @@ public function addPath($className, $methodName, $path)
             if ($option instanceof RequestValidation) {
                 $rules = array_merge($rules, $this->getValidateRule($option));
                 if ($option->dateType == 'json') {
-                    $param = new Body();
+                    $param = new Body("");
                     $param->rules = $this->getValidateRule($option);
                     $param->name = "body";
                     $param->key = "body";
@@ -99,6 +98,7 @@ public function addPath($className, $methodName, $path)
                 $consumes = $this->getConsumes($option->dateType);
                 continue;
             }
+
             if ($option instanceof Mapping) {
                 $mapping = $option;
             }
@@ -132,12 +132,13 @@ public function addPath($className, $methodName, $path)
         }
         $path = str_replace("/_self_path", "", $path);
         $path = $this->getPath($path);
-        $method = strtolower($mapping->methods[0]);
+
+        $method = strtolower($mapping->methods[0] ?? '');
         $this->swagger['paths'][$path][$method] = [
             'tags' => [$tag],
             'summary' => $mapping->summary ?? '',
             'description' => $mapping->description ?? '',
-            'operationId' => implode('', array_map('ucfirst', explode('/', $path))) . $mapping->methods[0],
+            'operationId' => implode('', array_map('ucfirst', explode('/', $path))) . ($mapping->methods[0] ?? ''),
             'parameters' => $this->makeParameters($params, $path, $method),
             'produces' => [
                 $consumes
@@ -147,7 +148,7 @@ public function addPath($className, $methodName, $path)
         if ($consumes !== null) {
             $this->swagger['paths'][$path][$method]['consumes'] = [$consumes];
         }
-        if (property_exists($mapping, 'security') && $mapping->security && isset($this->swagger['securityDefinitions'])) {
+        if ($mapping && property_exists($mapping, 'security') && $mapping->security && isset($this->swagger['securityDefinitions'])) {
             foreach ($this->swagger['securityDefinitions'] as $key => $val) {
                 $this->swagger['paths'][$path][$method]['security'][] = [$key => $val['petstore_auth'] ?? []];
             }
@@ -168,7 +169,7 @@ private function getConsumes($type = 'json')
 
     private function getValidateRule(RequestValidation $validation)
     {
-        if (class_exists($validation->validate)) {
+        if ($validation->validate && class_exists($validation->validate)) {
             $rolesModel = ReflectionManager::reflectClass($validation->validate)->getDefaultProperties();
             $rules = $rolesModel['scene'][$validation->scene] ?? [];
             $fields = $rolesModel['field'] ?? [];
@@ -254,7 +255,7 @@ private function rules2schema($name, $rules)
 
     public function getTypeByRule($rule)
     {
-       if (empty($rule)) {
+        if (empty($rule)) {
             return 'string';
         }
         $default = explode('|', preg_replace('/\[.*\]/', '', $rule));
@@ -294,7 +295,7 @@ public function makeParameters($params, $path, $method)
         $parameters = [];
         /** @var Query $item */
         foreach ($params as $item) {
-            if ($item->rule !== null && in_array('array', explode('|', $item->rule))) {
+            if ($item->rule && $item->rule !== null && in_array('array', explode('|', $item->rule))) {
                 $item->name .= '[]';
             }
             $parameters[$item->key] = [
@@ -467,7 +468,7 @@ public function save()
         $this->swagger['tags'] = array_values($this->swagger['tags'] ?? []);
         $outputFile = $this->config->get('swagger.output_file');
         if (!$outputFile) {
-            throw new \Exception('/config/autoload/swagger.php need set output_file');
+            throw new Exception('/config/autoload/swagger.php need set output_file');
         }
         $outputFile = str_replace('{server}', $this->server, $outputFile);
         file_put_contents($outputFile, json_encode($this->swagger, JSON_UNESCAPED_UNICODE | JSON_PRETTY_PRINT | JSON_UNESCAPED_SLASHES));

Original file line number	Diff line number	Diff line change
`@@ -2,17 +2,16 @@`
`2`	`2`	`declare(strict_types=1);`
`3`	`3`	`namespace HPlus\Swagger;`
`4`	`4`
`5`		`-use Doctrine\Common\Annotations\AnnotationReader;`
`6`	`5`	`use Hyperf\Di\Annotation\AnnotationCollector;`
	`6`	`+use Hyperf\Di\Annotation\AnnotationReader;`
`7`	`7`	`use Hyperf\Di\ReflectionManager;`
`8`	`8`
`9`	`9`	`class ApiAnnotation`
`10`	`10`	`{`
`11`	`11`	`public static function methodMetadata($className, $methodName)`
`12`	`12`	`{`
`13`	`13`	`$reflectMethod = ReflectionManager::reflectMethod($className, $methodName);`
`14`		`- $reader = new AnnotationReader();`
`15`		`-`
	`14`	`+ $reader = new AnnotationReader(config('annotations.scan.ignore_annotations', []));`
`16`	`15`	`return $reader->getMethodAnnotations($reflectMethod);`
`17`	`16`	`}`
`18`	`17`