init

Author: astral-data

composer.lock

@@ -0,0 +1,24 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Astral\Serialize\OpenApi\Annotations;
+
+use Attribute;
+
+#[Attribute(Attribute::TARGET_METHOD)]
+class Headers
+{
+    /**
+     * @param array $headers
+     * @param array $withOutHeaders
+     * @example
+     *   headers: [['company-id'=>'1'],['test-header'=>'test']]
+     *   withOutHeaders: ['test-header','company-id']
+     */
+    public function __construct(
+        public array $headers = [],
+        public array $withOutHeaders = []
+    ) {
+    }
+}

src/OpenApi/Annotations/Headers.php

@@ -0,0 +1,16 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Astral\Serialize\OpenApi\Annotations;
+
+use Attribute;
+
+#[Attribute(Attribute::TARGET_METHOD)]
+class OpenApi
+{
+    public function __construct(
+        public string $descriptions,
+    ) {
+    }
+}

src/OpenApi/Annotations/OpenApi.php

@@ -0,0 +1,20 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Astral\Serialize\OpenApi\Annotations;
+
+use Astral\Serialize\OpenApi\Enum\ContentTypeEnum;
+use Attribute;
+
+#[Attribute(Attribute::TARGET_METHOD)]
+class RequestBody
+{
+    public function __construct(
+        /** @var class-string $className */
+        public string $className = '',
+        public ContentTypeEnum $contentType = ContentTypeEnum::JSON,
+        public ?string $group = null
+    ){
+    }
+}

src/OpenApi/Annotations/RequestBody.php

@@ -0,0 +1,19 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Astral\Serialize\OpenApi\Annotations;
+
+use Attribute;
+
+#[Attribute(Attribute::TARGET_METHOD)]
+class Response
+{
+    public function __construct(
+        /** @var class-string $className */
+        public string $className,
+        public ?string $group = null,
+        public ?int $code = 200
+    ){
+    }
+}

src/OpenApi/Annotations/Response.php

@@ -0,0 +1,24 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Astral\Serialize\OpenApi\Annotations;
+
+use Astral\Serialize\OpenApi\Enum\MethodEnum;
+use Attribute;
+
+#[Attribute(Attribute::TARGET_METHOD)]
+class Route
+{
+    public function __construct(
+        public string $route,
+        public MethodEnum $method = MethodEnum::POST,
+        public array $attributes = [],
+    ) {
+    }
+
+    public function getMethod(): string
+    {
+        return 'April\\ApiDoc\\Storage\\OpenAPI\\Method\\' . $this->method->name;
+    }
+}

src/OpenApi/Annotations/Route.php

@@ -0,0 +1,21 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Astral\Serialize\OpenApi\Annotations;
+
+use Attribute;
+
+/**
+ * 方法注解类
+ */
+#[Attribute(Attribute::TARGET_METHOD)]
+class Summary
+{
+    public function __construct(
+        public string $value,
+        public string $description = ''
+    ) {
+
+    }
+}

src/OpenApi/Annotations/Summary.php

@@ -0,0 +1,26 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Astral\Serialize\OpenApi\Annotations;
+
+use Astral\Serialize\OpenApi\Storage\OpenAPI\TagStorage;
+use Attribute;
+
+/**
+ * 栏目注解类
+ */
+#[Attribute(Attribute::TARGET_CLASS)]
+class Tag
+{
+    public function __construct(
+        public string $value,
+        public string $description = ''
+    ) {
+    }
+
+    public function buildTagStorage(): TagStorage
+    {
+        return new TagStorage($this->value, $this->description);
+    }
+}

src/OpenApi/Annotations/Tag.php

@@ -0,0 +1,28 @@
+<?php
+
+namespace Astral\Serialize\OpenApi\Collections;
+
+use Astral\Serialize\OpenApi\Annotations\Headers;
+use Astral\Serialize\OpenApi\Annotations\Route;
+use Astral\Serialize\OpenApi\Annotations\Summary;
+
+class OpenApiCollection
+{
+    public function __construct(
+        public string $controllerClass,
+        public string $methodName,
+        public Summary $summary,
+        public Route $route,
+        public Headers $headers,
+        public array $attributes,
+        /** @var array<string, ParameterCollection> $parameters, */
+        public array $parameters = [],
+        /** @var array<string, ParameterCollection|mixed> $requestBody, */
+        public array $requestBody = [],
+        /** @var array<string, ParameterCollection|mixed> $responses, */
+        public array $response = [],
+
+    ){
+    }
+
+}

src/OpenApi/Collections/OpenApiCollection.php

@@ -0,0 +1,28 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Astral\Serialize\OpenApi\Collections;
+
+use Attribute;
+
+class ParameterCollection
+{
+    public function __construct(
+        /** @var string 元素变量名 */
+        public string $name,
+        /** @var string descriptions  */
+        public string $descriptions = '',
+        /** @var string 元素类型 */
+        public string $type = 'string',
+        /** @var mixed 示例值 */
+        public mixed $example = '',
+        /** @var bool 是否必填 */
+        public bool $required = false,
+        /** @var bool 是否忽略显示 */
+        public bool $ignore = false,
+        /** @var array<string, ParameterCollection> $children */
+        public array $children  = [],
+    ){
+    }
+}