feat: swagger

Author: liutao

README.md

@@ -45,3 +45,11 @@ php bin/console start
 ```shell
 composer cs ./app
 ```
+
+### 生成Swagger文档
+```shell
+发布配置
+php bin/console config:publish swagger
+生成文档
+php bin/console swagger:gen
+```

app/Controller/Index.php

@@ -0,0 +1,42 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Controller;
+
+use App\Dto\Request\IndexGetReq;
+use App\Dto\Response\IndexGetRes;
+use MicroPHP\Framework\Controller;
+use MicroPHP\Framework\Http\Response;
+use MicroPHP\Framework\Http\ServerRequest;
+use MicroPHP\Swagger\Schema\Get;
+use MicroPHP\Swagger\Schema\Post;
+use MicroPHP\Swagger\Schema\RequestBody;
+use MicroPHP\Swagger\Schema\SuccessJsonResponse;
+use OpenApi\Attributes\Info;
+use OpenApi\Attributes\OpenApi;
+use OpenApi\Attributes\Server;
+
+#[OpenApi(
+    info: new Info(version: '1.0', title: 'micro-php'),
+    servers: [new Server(url: 'http://127.0.0.1:8080')]
+)]
+class IndexController extends Controller
+{
+    public const TAG = 'Index';
+
+    #[Get(summary: '首页', tags: [self::TAG])]
+    #[SuccessJsonResponse(ref: IndexGetRes::class)]
+    public function index(ServerRequest $request): Response
+    {
+        return $this->json('Hello World');
+    }
+
+    #[Post(summary: '获取', tags: [self::TAG])]
+    #[RequestBody(ref: IndexGetReq::class)]
+    #[SuccessJsonResponse(ref: IndexGetRes::class)]
+    public function get(ServerRequest $request): Response
+    {
+        return $this->json(new IndexGetRes(['id' => $request->input('id'), 'name' => 'hello']));
+    }
+}

app/Controller/IndexController.php

@@ -0,0 +1,15 @@
+<?php
+declare(strict_types=1);
+
+namespace App\Dto\Request;
+
+use MicroPHP\Data\Data;
+use MicroPHP\Swagger\Schema\Property;
+use MicroPHP\Swagger\Schema\Schema;
+
+#[Schema(title: 'index请求参数')]
+class IndexGetReq extends Data
+{
+    #[Property(title: 'ID', example: 1)]
+    public int $id = 1;
+}

app/Dto/Request/IndexGetReq.php

@@ -0,0 +1,18 @@
+<?php
+declare(strict_types=1);
+
+namespace App\Dto\Response;
+
+use MicroPHP\Data\Data;
+use MicroPHP\Swagger\Schema\Property;
+use MicroPHP\Swagger\Schema\Schema;
+
+#[Schema(title: 'index响应参数')]
+class IndexGetRes extends Data
+{
+    #[Property(title: 'ID', example: 1)]
+    public int $id;
+
+    #[Property(title: '名字', example: 'test')]
+    public string $name;
+}

app/Dto/Response/IndexGetRes.php

@@ -2,15 +2,15 @@
 
 declare(strict_types=1);
 
-use App\Controller\Index;
+use App\Controller\IndexController;
 use App\Middleware\NothingMiddleware;
 use MicroPHP\Framework\Http\Response;
 use MicroPHP\Framework\Router\Router;
 
 $router = new Router();
 
-$router->get('/', [Index::class, 'index'])->middleware(new NothingMiddleware());
-$router->post('/', [Index::class, 'index'])->middleware(new NothingMiddleware());
+$router->get('/', [IndexController::class, 'index'])->middleware(new NothingMiddleware());
+$router->post('/get', [IndexController::class, 'get'])->middleware(new NothingMiddleware());
 
 $router->get('/favicon.ico', function () {
     return new Response(200, [], '');