update5.2.0

HGthecode · HGthecode · commit 1ba474925b44 · 2023-06-30T14:25:04.000+08:00
diff --git a/src/annotation/NotDebug.php b/src/annotation/NotDebug.php
@@ -0,0 +1,22 @@
+<?php
+
+namespace hg\apidoc\annotation;
+
+use Attribute;
+use hg\apidoc\utils\AbstractAnnotation;
+
+/**
+ * 关闭接口调试
+ * @package hg\apidoc\annotation
+ * @Annotation
+ * @Target({"METHOD","CLASS"})
+ */
+#[Attribute(Attribute::TARGET_CLASS | \Attribute::IS_REPEATABLE)]
+class NotDebug extends AbstractAnnotation
+{
+
+    public function __construct(...$value)
+    {
+        parent::__construct(...$value);
+    }
+}
diff --git a/src/annotation/NotDefaultAuthor.php b/src/annotation/NotDefaultAuthor.php
@@ -0,0 +1,22 @@
+<?php
+
+namespace hg\apidoc\annotation;
+
+use Attribute;
+use hg\apidoc\utils\AbstractAnnotation;
+
+/**
+ * 不使用默认作者
+ * @package hg\apidoc\annotation
+ * @Annotation
+ * @Target({"METHOD"})
+ */
+#[Attribute(Attribute::TARGET_CLASS | \Attribute::IS_REPEATABLE)]
+class NotDefaultAuthor extends AbstractAnnotation
+{
+
+    public function __construct(...$value)
+    {
+        parent::__construct(...$value);
+    }
+}
diff --git a/src/annotation/NotHeaders.php b/src/annotation/NotHeaders.php
@@ -0,0 +1,22 @@
+<?php
+
+namespace hg\apidoc\annotation;
+
+use Attribute;
+use hg\apidoc\utils\AbstractAnnotation;
+
+/**
+ * 不使用配置中的全局请求Headers参数
+ * @package hg\apidoc\annotation
+ * @Annotation
+ * @Target({"METHOD"})
+ */
+#[Attribute(Attribute::TARGET_CLASS | \Attribute::IS_REPEATABLE)]
+class NotHeaders extends AbstractAnnotation
+{
+
+    public function __construct(...$value)
+    {
+        parent::__construct(...$value);
+    }
+}
diff --git a/src/annotation/NotParams.php b/src/annotation/NotParams.php
@@ -0,0 +1,22 @@
+<?php
+
+namespace hg\apidoc\annotation;
+
+use Attribute;
+use hg\apidoc\utils\AbstractAnnotation;
+
+/**
+ * 不使用配置中的全局请求Body参数
+ * @package hg\apidoc\annotation
+ * @Annotation
+ * @Target({"METHOD"})
+ */
+#[Attribute(Attribute::TARGET_CLASS | \Attribute::IS_REPEATABLE)]
+class NotParams extends AbstractAnnotation
+{
+
+    public function __construct(...$value)
+    {
+        parent::__construct(...$value);
+    }
+}
diff --git a/src/annotation/NotParse.php b/src/annotation/NotParse.php
@@ -0,0 +1,24 @@
+<?php
+
+namespace hg\apidoc\annotation;
+
+use Attribute;
+use hg\apidoc\utils\AbstractAnnotation;
+
+/**
+ * 标记不解析的控制器/方法
+ * @package hg\apidoc\annotation
+ * @Annotation
+ * @Target({"METHOD","CLASS"})
+ */
+#[Attribute(Attribute::TARGET_CLASS | \Attribute::IS_REPEATABLE)]
+class NotParse extends AbstractAnnotation
+{
+    /**
+     * @param string $value 不解析
+     */
+    public function __construct(...$value)
+    {
+        parent::__construct(...$value);
+    }
+}
diff --git a/src/annotation/NotQuerys.php b/src/annotation/NotQuerys.php
@@ -0,0 +1,22 @@
+<?php
+
+namespace hg\apidoc\annotation;
+
+use Attribute;
+use hg\apidoc\utils\AbstractAnnotation;
+
+/**
+ * 不使用配置中的全局请求Querys参数
+ * @package hg\apidoc\annotation
+ * @Annotation
+ * @Target({"METHOD"})
+ */
+#[Attribute(Attribute::TARGET_CLASS | \Attribute::IS_REPEATABLE)]
+class NotQuerys extends AbstractAnnotation
+{
+
+    public function __construct(...$value)
+    {
+        parent::__construct(...$value);
+    }
+}
diff --git a/src/annotation/NotResponseError.php b/src/annotation/NotResponseError.php
@@ -0,0 +1,22 @@
+<?php
+
+namespace hg\apidoc\annotation;
+
+use Attribute;
+use hg\apidoc\utils\AbstractAnnotation;
+
+/**
+ * 不使用异常响应体返回数据
+ * @package hg\apidoc\annotation
+ * @Annotation
+ * @Target({"METHOD"})
+ */
+#[Attribute(Attribute::TARGET_CLASS | \Attribute::IS_REPEATABLE)]
+class NotResponseError extends AbstractAnnotation
+{
+
+    public function __construct(...$value)
+    {
+        parent::__construct(...$value);
+    }
+}
diff --git a/src/annotation/NotResponseSuccess.php b/src/annotation/NotResponseSuccess.php
@@ -0,0 +1,22 @@
+<?php
+
+namespace hg\apidoc\annotation;
+
+use Attribute;
+use hg\apidoc\utils\AbstractAnnotation;
+
+/**
+ * 不使用成功响应体返回数据
+ * @package hg\apidoc\annotation
+ * @Annotation
+ * @Target({"METHOD"})
+ */
+#[Attribute(Attribute::TARGET_CLASS | \Attribute::IS_REPEATABLE)]
+class NotResponseSuccess extends AbstractAnnotation
+{
+
+    public function __construct(...$value)
+    {
+        parent::__construct(...$value);
+    }
+}
diff --git a/src/annotation/NotResponses.php b/src/annotation/NotResponses.php
@@ -0,0 +1,22 @@
+<?php
+
+namespace hg\apidoc\annotation;
+
+use Attribute;
+use hg\apidoc\utils\AbstractAnnotation;
+
+/**
+ * 不使用统一响应体返回数据
+ * @package hg\apidoc\annotation
+ * @Annotation
+ * @Target({"METHOD"})
+ */
+#[Attribute(Attribute::TARGET_CLASS | \Attribute::IS_REPEATABLE)]
+class NotResponses extends AbstractAnnotation
+{
+
+    public function __construct(...$value)
+    {
+        parent::__construct(...$value);
+    }
+}
diff --git a/src/annotation/Property.php b/src/annotation/Property.php
@@ -0,0 +1,62 @@
+<?php
+
+namespace hg\apidoc\annotation;
+
+use Attribute;
+
+/**
+ * 类的属性
+ * @Annotation
+ * @Target({"METHOD","ANNOTATION","PROPERTY"})
+ */
+#[Attribute(Attribute::TARGET_METHOD | Attribute::IS_REPEATABLE | Attribute::TARGET_PROPERTY)]
+class Property extends ParamBase
+{
+
+    /**
+     * mock
+     * @var string
+     */
+    public $mock;
+
+    /**
+     * @param string $name 字段名
+     * @param string $type 字段类型
+     * @param bool $require 是否必须
+     * @param string|int|bool $default 默认值
+     * @param string|array $ref 引用注解/模型
+     * @param string $table 引用数据表
+     * @param string|array $field 指定Ref引入的字段
+     * @param string|array $withoutField 排除Ref引入的字段
+     * @param string $desc 字段名称
+     * @param string $md Md文本内容
+     * @param string $mock Mock规则
+     * @param array $children 子参数
+     * @param string $childrenField 为tree类型时指定children字段
+     * @param string $childrenDesc 为tree类型时指定children字段说明
+     * @param string $childrenType 为array类型时指定子节点类型
+     */
+    public function __construct(
+        $name = '',
+        string $type = '',
+        bool $require = false,
+        $default = "",
+        $ref = "",
+        $table = "",
+        $field = "",
+        $withoutField = "",
+        string $desc = '',
+        string $md = "",
+        string $mock = "",
+        array $children = [],
+        string $childrenField = "",
+        string $childrenDesc = "children",
+        string $childrenType = "",
+        ...$attrs
+    )
+    {
+        parent::__construct(...func_get_args());
+    }
+
+
+}
diff --git a/src/parses/ParseAnnotation.php b/src/parses/ParseAnnotation.php
@@ -8,7 +8,8 @@
 use ReflectionAttribute;
 use hg\apidoc\exception\ErrorException;
 use ReflectionMethod;
-use think\facade\Log;
+use ReflectionParameter;
+use support\Log;
 
 class ParseAnnotation
 {
@@ -27,9 +28,10 @@ public function __construct($config)
     /**
      * 解析非@注解的文本注释
      * @param $refMethod
+     * @param $isAll bool 是否获取全部，true则将带@开头的注释也包含
      * @return array|false
      */
-    public static function parseTextAnnotation($refMethod): array
+    public static function parseTextAnnotation($refMethod,$isAll=false): array
     {
         $annotation = $refMethod->getDocComment();
         if (empty($annotation)) {
@@ -43,7 +45,7 @@ public static function parseTextAnnotation($refMethod): array
         $data = [];
         foreach ($lines[1] as $line) {
             $line = trim($line);
-            if (!empty ($line) && strpos($line, '@') !== 0) {
+            if (!empty ($line) && ($isAll===true || ($isAll===false && strpos($line, '@') !== 0))) {
                 $data[] = $line;
             }
         }
@@ -92,8 +94,8 @@ protected function getParameters($attrList){
             }else{
                 $name    = $this->getClassName(get_class($item));
                 $valueObj = Helper::objectToArray($item);
-                if (isset($valueObj['name']) && count($valueObj)===1){
-                    $value = $valueObj['name'];
+                if (array_key_exists('name',$valueObj) && count($valueObj)===1){
+                    $value = $valueObj['name']===null?true: $valueObj['name'];
                 }else{
                     $value = $valueObj;
                 }
@@ -139,4 +141,78 @@ public function getMethodAnnotation(ReflectionMethod $refMethod){
         return $this->getParameters(array_merge($attributes,$readerAttributes));
     }
 
+    /**
+     * 获取属性的注解参数
+     * @param $property
+     * @return array
+     */
+    public function getPropertyAnnotation($property){
+        if (method_exists($property,'getAttributes')){
+            $attributes = $property->getAttributes();
+        }else{
+            $attributes = [];
+        }
+        $readerAttributes = $this->parser->getPropertyAnnotations($property);
+        return $this->getParameters(array_merge($attributes,$readerAttributes));
+    }
+
+    /**
+     * 解析类的属性文本注释的var
+     * @param $propertyTextAnnotations
+     * @return array
+     */
+    protected static function parsesPropertyTextAnnotation($propertyTextAnnotations){
+        $varLine = "";
+        foreach ($propertyTextAnnotations as $item) {
+            if (strpos($item, '@var') !== false){
+                $varLine = $item;
+                break;
+            }
+        }
+        $type = "";
+        $desc = "";
+        if ($varLine){
+            $varLineArr = preg_split('/\\s+/', $varLine);
+            $type = !empty($varLineArr[1])?$varLineArr[1]:"";
+            $desc = !empty($varLineArr[2])?$varLineArr[2]:"";
+        }
+        if (empty($desc) && strpos($propertyTextAnnotations[0], '@var') === false){
+            $desc = $propertyTextAnnotations[0];
+        }
+        return [
+            'type'=>$type,
+            'desc'=>$desc,
+        ];
+    }
+
+    /**
+     * 获取类的属性参数
+     * @param $classReflect
+     * @return array
+     */
+    public function getClassPropertiesy($classReflect){
+        $publicProperties = $classReflect->getProperties(\ReflectionProperty::IS_PUBLIC);
+        $arr=[];
+        foreach ($publicProperties as $property) {
+              $propertyAnnotations = $this->getPropertyAnnotation($property);
+              $item = [];
+              if (!empty($propertyAnnotations['property'])){
+                  // 有apidoc注解
+                  $arr[] = $propertyAnnotations['property'];
+                  continue;
+              }
+              $propertyTextAnnotations = self::parseTextAnnotation($property,true);
+              if (empty($propertyTextAnnotations)){
+                  // 无注释
+                  continue;
+              }
+              $textAnnotationsParams=static::parsesPropertyTextAnnotation($propertyTextAnnotations);
+              $textAnnotationsParams['name'] =$property->getName();
+              $arr[]=$textAnnotationsParams;
+        }
+        return $arr;
+    }
+
+
+
 }
diff --git a/src/parses/ParseApiDetail.php b/src/parses/ParseApiDetail.php
diff --git a/src/parses/ParseApiMenus.php b/src/parses/ParseApiMenus.php
diff --git a/src/parses/ParseModel.php b/src/parses/ParseModel.php
diff --git a/src/utils/AutoRegisterRouts.php b/src/utils/AutoRegisterRouts.php
