ホームページ > 記事 > PHPフレームワーク > API インターフェースのドキュメント管理に ThinkPHP6 を使用するにはどうすればよいですか?
インターネットの発展に伴い、Web API (Application Programming Interface) はますます一般的かつ重要になってきています。 Web API プロバイダーにとって、完全でわかりやすい API ドキュメントを作成することが非常に必要です。現在、API ドキュメントを簡単に生成できるツールが多数あり、その中で最も人気のあるツールは Swagger です。ただし、この記事では、ThinkPHP6 フレームワークで提供される API インターフェースのドキュメント管理を使用して API ドキュメントを管理する方法に焦点を当てます。
最初に、「topthink/think-apidoc」という名前の API ドキュメント管理拡張機能を ThinkPHP6 プロジェクトにインストールする必要があります。プロジェクトのルート ディレクトリで Composer コマンド ライン ツールを使用してインストールできます。
composer require topthink/think-apidoc
インストールが完了したら、API の作成を開始できます。インターフェイスのドキュメント。 ThinkPHP6 では、コントローラー メソッドでアノテーションを使用して API インターフェイス ドキュメントを作成できます。例:
/** * 获取用户信息 * * @ApiTitle (获取用户信息) * @ApiSummary (通过用户ID获取用户信息) * @ApiMethod (GET) * @ApiRoute (/user/:id) * @ApiParams (name="id", type="integer", required=true, description="用户ID") * @ApiReturn ({"code": 200, "msg": "success", "data": {"id": 1, "name": "张三", "age": 18}}) * @ApiHeaders (name="Authorization", type="string", required=true, description="用户授权Token") */ public function getUserInfo($id) { // TODO: 获取用户信息的逻辑 }
上記のコメントでは、API インターフェイスを説明するためにいくつかの異なる注釈を使用しました:
上記のコメントにより、API の基本情報を明確に記述することができます。インターフェース。
API インターフェイス ドキュメントを作成した後、ThinkPHP6 が提供するコマンド ライン ツールを使用して API ドキュメントを生成できます。プロジェクトのルート ディレクトリで次のコマンドを実行するだけです:
php think apidoc --module api --path ./public/apidoc --type json
上記のコマンドでは、apido のストレージ パスと生成されるドキュメント タイプ (ここでは json 形式が選択されています) を指定しました。 --module パラメーターを「api」として指定したことにも注意してください。これは、「api」モジュールの API ドキュメントのみを生成することを意味します。実際のアプリケーションでは、ニーズに応じて選択できます。
上記のコマンドを実行すると、指定されたストレージ パスで生成された API ドキュメントを見つけることができます。この時点で、API インターフェースの基本情報を理解しやすくするために、それらをインターフェースのユーザーに渡すことができます。
質問を考える:
既存のプロジェクトでドキュメント管理拡張機能を使用し、対応するコントローラーとメソッドにコメントを追加した場合、3 つの操作ステップの後に 2 番目の操作を実行します。生成される API インターフェイス ドキュメントは次のようになりますか?
以上がAPI インターフェースのドキュメント管理に ThinkPHP6 を使用するにはどうすればよいですか?の詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。