API 문서 생성을 위해 Hyperf 프레임워크를 사용하는 방법

API 문서 생성을 위해 Hyperf 프레임워크를 사용하는 방법

소개:
인터넷의 급속한 발전과 함께 API(애플리케이션 프로그래밍 인터페이스)는 필수 요소가 되었으며, API(애플리케이션 프로그래밍 인터페이스)는 다양한 애플리케이션을 연결하여 데이터 공유 및 상호 작용을 달성할 수 있습니다. . 개발팀에게 좋은 API 문서는 팀 협업을 보장하는 중요한 도구입니다. 이 기사에서는 Hyperf 프레임워크를 사용하여 명확하고 사용하기 쉬운 API 문서를 생성하는 방법을 소개하고 특정 코드 예제를 통해 이를 보여줍니다.

1. 준비
Hyperf 프레임워크를 사용하여 API 문서를 생성하기 전에 다음을 준비해야 합니다.

1. Hyperf 프레임워크 설치: Composer 도구를 사용하여 Hyperf 프레임워크를 빠르고 쉽게 설치합니다.
2. 라우팅 구성: config/routes.php 파일에서 라우팅 정보를 구성합니다.
3. API 문서 생성 도구 설치: Hyperf 프레임워크에는 Composer를 통해 설치할 수 있는 Swaggervel이라는 공식 권장 API 문서 생성 도구가 있습니다.

2. API 문서 생성
다음은 Hyperf 프레임워크를 사용하여 API 문서를 생성하는 구체적인 단계와 코드 예제입니다.

1. Swaggervel 설치

   composer require overtrue/laravel-swagger

2. 문서 생성기 클래스 만들기
   앱 아래에 만들기 /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

위 내용은 API 문서 생성을 위해 Hyperf 프레임워크를 사용하는 방법의 상세 내용입니다. 자세한 내용은 PHP 중국어 웹사이트의 기타 관련 기사를 참조하세요!