ThinkPHP6 での OpenAPI の使用

インターネット技術の発展に伴い、データ対話用の標準化プロトコルとしての API (アプリケーション プログラミング インターフェイス) は、現代のソフトウェア開発に不可欠な部分になりました。 OpenAPI は、汎用 API 記述ファイル形式として、API の設計、開発、ドキュメントの作成に広く使用されています。この記事では、API の開発と管理をより良く実現するために、ThinkPHP6 で OpenAPI を使用する方法を紹介します。

1. OpenAPI の概要

OpenAPI は、OpenAPI 仕様委員会 (OpenAPI Initiative) によって開発されたオープン標準 API 記述ファイル形式です。 JSON または YAML 形式に基づいており、RESTful API のインターフェイス仕様、形式、パラメータ、応答、セキュリティ、その他の情報を定義するために使用されます。 OpenAPI の目的は、API の開発、リリース、ドキュメントのプロセスを標準化し、API の再利用性と相互運用性を確保することです。

2. OpenAPI 拡張ライブラリをインストールする

ThinkPHP6 で OpenAPI を使用するには、まず対応する拡張ライブラリをインストールする必要があります (Composer を通じてインストールできます)。コマンド ライン ツールを開き、ThinkPHP6 プロジェクトのルート ディレクトリに切り替えて、次のコマンドを入力します。

composer require zircote/swagger-php

インストールが完了すると、swagger-php フォルダーがベンダー ディレクトリに生成されます。 OpenAPI 拡張ライブラリは正常にインストールされました。

3. OpenAPI ドキュメントの作成

ThinkPHP6 では、コメントを通じて OpenAPI ドキュメントを作成できます。 OpenAPI ドキュメントを作成する必要があるメソッドに次のアノテーションを追加します:

/**
 * @OAGet(
 *   path="/api/users/{id}",
 *   summary="获取用户信息",
 *   tags={"Users"},
 *   @OAParameter(
 *     name="id",
 *     in="path",
 *     description="用户ID",
 *     required=true,
 *     @OASchema(
 *          type="integer"
 *     )
 *   ),
 *   @OAResponse(
 *     response=200,
 *     description="获取成功",
 *     @OAJsonContent(
 *        @OAProperty(property="id", type="integer", description="用户ID"),
 *        @OAProperty(property="name", type="string", description="用户姓名"),
 *        @OAProperty(property="age", type="integer", description="用户年龄")
 *     )
 * ),
 * @OAResponse(
 *     response=404,
 *     description="未找到该用户",
 *     @OAJsonContent(
 *        @OAProperty(property="message", type="string", description="错误信息")
 *     )
 *   )
 * )
 */

このうち、@OAGet はこれが HTTP GET リクエストであることを示し、path 属性は API のリクエスト パスを示し、summary 属性はは API の概要情報、tags 属性は API のラベルを示します、@OAParameter は API のパラメータ情報を表します、@OASchema はパラメータのタイプとその他の情報を表します、@OAResponse は API の応答情報を表します、@OAJsonContent応答内容を JSON 形式で表します。利用可能なアノテーションの詳細については、公式ドキュメントを参照してください。

4. OpenAPI ドキュメントの生成

コメントを追加した後、次のコマンドを実行することで OpenAPI ドキュメントを生成できます:

php think swagger:export --output=./public/swagger.json

その中で、--output は出力ファイルを指定します。パス。

5. OpenAPI ドキュメントの使用

OpenAPI ドキュメントを生成した後、Swagger UI ツールを通じて OpenAPI を表示および使用できます。 Swagger UI ソース コードをダウンロードして Web サーバー ディレクトリに抽出し、index.html ファイルにアクセスして Swagger UI インターフェイスを確認します。インターフェイスのリクエスト アドレス入力ボックスに、生成された OpenAPI ドキュメント アドレスを入力して、API インターフェイスを表示およびテストします。

6. 概要

完全な API の開発は複雑なタスクになる可能性があります。OpenAPI を使用すると、API の開発とドキュメントの標準化と管理、API の品質の向上に役立ちます。再利用性と相互運用性。 ThinkPHP6 で OpenAPI を使用することも非常に便利で、OpenAPI 拡張ライブラリをインストールしてコメントを追加するだけで、簡単に API ドキュメントを作成できます。したがって、開発者は API の設計と実装により集中できるようになり、開発効率とコードの品質が向上します。

以上がThinkPHP6 での OpenAPI の使用の詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。