Hyperf フレームワークを使用してインターフェイス ドキュメントを生成する方法

Hyperf フレームワークを使用してインターフェイス ドキュメントを生成する方法

Web アプリケーションの急速な開発に伴い、インターフェイス ドキュメントの作成と保守の重要性がますます高まっています。インターフェイス ドキュメントは、開発者が API をよりよく理解して使用できるようにし、開発効率と共同開発機能を向上させるのに役立ちます。日常の開発では、インターフェイス ドキュメントを手動で作成して更新する必要があることがよくありますが、これは比較的面倒でエラーが発生しやすい作業です。この問題を解決するには、Hyperf フレームワークの自動ツールを使用して、アノテーションを通じてインターフェイス ドキュメントを生成します。

Hyperf フレームワークは、Swoole および Hyperf コンポーネントに基づく高性能フレームワークであり、開発プロセスを簡素化するための一連のアノテーションを提供します。このうち、「@RequestMapping」アノテーションを使用してインターフェースを定義し、「@Api」アノテーションを使用してインターフェース文書を生成できます。

まず、Hyperf フレームワークと対応する依存関係をプロジェクトに導入する必要があります。次の内容をcomposer.jsonファイルに追加します:

{
    "require": {
        "hyperf/http-server": "^2.0",
        "phpstan/phpstan": "^0.9.0",
        "phpstan/phpstan-strict-rules": "^0.9.0",
        "symfony/console": "^5.0"
    }
}

そして、composer update コマンドを実行して依存関係をインストールします。

次に、インターフェイスを定義するコントローラーを作成します。 app/Controller ディレクトリに IndexController.php ファイルを作成します。コードは次のとおりです:

<?php

declare(strict_types=1);

namespace AppController;

use HyperfHttpServerAnnotationController;
use HyperfHttpServerAnnotationRequestMapping;
use HyperfDiAnnotationInject;
use HyperfContractStdoutLoggerInterface;
use AppServiceHelloService;

/**
 * @Controller()
 * @Api(name="Hello接口")
 */
class IndexController
{
    /**
     * @Inject()
     * @var HelloService
     */
    private $helloService;

    /**
     * @RequestMapping(path="/hello/{name}", methods="get")
     * @param string $name
     */
    public function hello(string $name)
    {
        return $this->helloService->sayHello($name);
    }
}

上記のコードでは、IndexController を定義しますController であり、hello メソッドの @RequestMapping アノテーションを使用してインターフェイスを定義します。さらに、@Api アノテーションを使用してインターフェイス ドキュメントを生成し、@Inject アノテーションを使用して HelloService サービスを挿入しました。

次に、Hyperf フレームワークのカスタム コマンドを使用して、インターフェイス ドキュメントを生成できます。プロジェクトのルート ディレクトリに doc ディレクトリを作成し、その中に generate.php ファイルを作成します。コードは次のとおりです:

<?php

declare(strict_types=1);

use HyperfCommandCommand as HyperfCommand;
use HyperfCommandAnnotationCommand;
use PsrContainerContainerInterface;
use HyperfApiDocCommandGenerateApiDocCommand;

/**
 * @Command
 */
class DocCommand extends HyperfCommand
{
    /**
     * @var ContainerInterface
     */
    protected $container;

    public function __construct(ContainerInterface $container)
    {
        $this->container = $container;

        parent::__construct('doc:generate');
    }

    public function configure()
    {
        parent::configure();
        $this->setDescription('Generate api doc for the project');
    }

    public function handle()
    {
        $command = new ApiDocCommand($this->container);
        $command->setOutput($this->output);
        $command->setInput($this->input);
        return $command->handle();
    }
}

上記のコードでは、 create カスタム DocCommand コマンドが作成され、Hyperf フレームワークによって提供される ApiDocCommand コマンドが handle メソッドで呼び出され、インターフェイス ドキュメントが生成されます。

最後に、ターミナルで php doc/generate.php コマンドを実行して、インターフェイス ドキュメントを生成します。実行が成功すると、プロジェクトのルート ディレクトリの public ディレクトリに生成されたインターフェイス ドキュメントが表示されます。

上記の手順により、Hyperf フレームワークを使用してインターフェイス ドキュメントを正常に生成できました。アノテーションを通じてインターフェースを定義することで、ドキュメントをより簡潔に記述でき、手動でドキュメントを作成する作業負荷を軽減できます。同時に、Hyperf フレームワークによって提供されるカスタム コマンドもドキュメント生成プロセスをより便利にします。

要約すると、Hyperf フレームワークを使用してインターフェイス ドキュメントを生成すると、開発効率が向上するだけでなく、ドキュメントの正確さと一貫性も確保されます。この記事が、Hyperf フレームワークを使用してインターフェイス ドキュメントを生成する際の皆様のお役に立てれば幸いです。

コードサンプル: https://github.com/xxx/xxx

以上がHyperf フレームワークを使用してインターフェイス ドキュメントを生成する方法の詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。