如何使用Hyperf框架進行API文檔生成

如何使用Hyperf框架進行API文檔生成

引言：
隨著互聯網的快速發展，API（Application Programming Interface）已經成為了不可或缺的一部分，它可以將不同的應用程式連接起來，實現資料的共享與互動。對開發團隊來說，良好的API文件是保證團隊協作的重要工具。本文將介紹如何利用Hyperf框架來產生清晰、易用的API文檔，透過具體的程式碼範例來進行展示。

一、準備工作
在開始使用Hyperf框架產生API文件之前，需要進行以下準備：

1. 安裝Hyperf框架：使用Composer工具可以簡單快速地安裝Hyperf框架。
2. 設定路由：在config/routes.php檔案中設定路由資訊。
3. 安裝API文件產生工具：Hyperf框架有一個官方推薦的API文件產生工具，稱為Swaggervel，可以透過Composer進行安裝。

二、產生API文件
以下是使用Hyperf框架產生API文件的特定步驟與程式碼範例：

1. 安裝Swaggervel

   composer require overtrue/laravel-swagger

2. 建立一個文件產生器類別
   在app/Doc資料夾下建立一個DocGenerator.php文件，並在其中編寫以下程式碼：

   <?php
   
   namespace AppDoc;
   
   use HyperfValidationContractValidatorFactoryInterface;
   use OvertrueLaravelSwaggerRequest;
   use OvertrueLaravelSwaggerSwagger as BaseSwagger;
   
   class DocGenerator
   {
    protected $validator;
   
    public function __construct(ValidatorFactoryInterface $validator)
    {
        $this->validator = $validator;
    }
   
    public function generate()
    {
        $swagger = new BaseSwagger([
            'swagger' => '2.0',
            'info' => [
                'title' => config('app.name'),
                'version' => config('app.version'),
            ],
        ]);
   
        $routes = app('router')->getRoutes();
   
        foreach ($routes as $route) {
            $methods = $route->methods();
            $path = $route->uri();
   
            foreach ($methods as $method) {
                $request = new Request([
                    'method' => $method,
                    'uri' => $route->uri(),
                ]);
   
                $docBlock = $route->getAction()['doc'] ?? null; // 从Route中获取注释
   
                $parameters = [];
   
                $validator = $this->validator->make($request->all(), $docBlock ? $docBlock['rules'] : []);
   
                foreach ($validator->failed() as $field => $messages) {
                    $parameters[] = [
                        'name' => $field,
                        'in' => 'query',
                        'required' => true,
                        'description' => implode(', ', $messages),
                    ];
                }
   
                $responses = [];
   
                $responses[] = [
                    'statusCode' => 200,
                    'description' => '请求成功',
                    'data' => [
                        'type' => 'object',
                        'properties' => [
                            'code' => [
                                'type' => 'integer',
                            ],
                            'message' => [
                                'type' => 'string',
                            ],
                            'data' => [
                                'type' => 'object',
                                'nullable' => true,
                            ],
                        ],
                    ],
                ];
   
                $swagger->addPath($path, $method, [
                    'parameters' => $parameters,
                    'responses' => $responses,
                ]);
            }
        }
   
        return $swagger->toYaml();
    }
   }

3. #設定存取路由
   在config/routes.php檔案中新增以下路由設定：

   use AppDocDocGenerator;
   
   Router::get('/api/docs', function (DocGenerator $docGenerator) {
    return $docGenerator->generate();
   });

4. #產生API文件
   在終端機中執行下列指令產生API文件：

   php bin/hyperf.php serve

以上是如何使用Hyperf框架進行API文檔生成的詳細內容。更多資訊請關注PHP中文網其他相關文章！