update5.2.0

Author: HGthecode

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);
+    }
+}

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);
+    }
+}

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);
+    }
+}

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);
+    }
+}

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);
+    }
+}

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);
+    }
+}

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);
+    }
+}

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);
+    }
+}

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);
+    }
+}

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());
+    }
+
+
+}