Swagger Codegen を使用して PHP で API クライアントおよびサーバー コードを生成する方法

Swagger は、API の構造と操作を説明するための読みやすい形式を定義する標準 API ドキュメント仕様です。 Swagger Codegen は、Swagger 仕様から API クライアントおよびサーバー コードを自動的に生成できるツールです。 PHP では、Swagger Codegen を使用すると、PHP API クライアントおよびサーバー コードを簡単に生成でき、時間と労力を大幅に節約できます。

以下では、Swagger Codegen を使用して PHP で API クライアントおよびサーバー コードを生成する方法を紹介します。

ステップ 1: Swagger Codegen ツールをインストールする

まず、Swagger Codegen ツールをインストールする必要があります。 GitHub の Swagger Codegen プロジェクト ページからダウンロードしたり、プリコンパイルされたバイナリや Docker コンテナを使用してインストールしたりできます。

ステップ 2: Swagger 仕様ファイルを作成する

次に、Swagger 仕様ファイルを作成する必要があります。これは、Swagger 仕様ファイルの構造、操作、パラメーター、およびその他の情報を記述する JSON または YAML ファイルです。 API 。 Swagger 仕様ファイルの作成方法がわからない場合は、Swagger Editor (https://editor.swagger.io/) のグラフィカル インターフェイスを使用して作成できます。

仕様ファイルの作成が完了したら、swagger.json または swagger.yaml 形式のファイルとして保存し、ファイルに必要な情報が含まれていることを確認してください。 APIの基本情報、ルーティング、パラメータなどの情報。

ステップ 3: Swagger Codegen を使用して PHP クライアント コードを生成する

次のコマンドを使用して PHP クライアント コードを生成します:

swagger-codegen generate -i swagger.yaml -l php -o client/php

その中に、swagger.yaml は、作成したばかりの Swagger 仕様ファイルのファイル パスです。client/php は、PHP クライアント コードの生成に使用されるプロジェクト ディレクトリです。

この後、Swagger Codegen は PHP クライアント コードを自動的に生成し、Swagger 仕様ファイルで定義されているすべての API 操作を含む API クライアント ライブラリを生成します。

ステップ 4: Swagger Codegen を使用して PHP サーバー コードを生成する

次のコマンドを使用して PHP サーバー コードを生成します:

swagger-codegen generate -i swagger.yaml -l php-server -o server/php

その中に、swagger.yaml は、作成したばかりの Swagger 仕様ファイルのファイル パスです。server/php は、PHP サーバー コードの生成に使用されるプロジェクト ディレクトリです。

この後、Swagger Codegen は PHP サーバー コードを自動的に生成し、Swagger 仕様ファイルで定義されているすべての API 操作を含む API サーバー ライブラリを生成します。

ステップ 5: 生成されたクライアント コードとサーバー コードを使用する

この後、生成された PHP クライアント コードとサーバー コードを使用して API を呼び出すことができます。クライアントとサーバーのコード ライブラリを参照し、その関数とメソッドを使用して API にアクセスするだけです。

たとえば、PHP クライアント コードを生成した場合は、次のコードを使用して API を呼び出すことができます。

require_once(__DIR__ . '/client/php/autoload.php');

$apiInstance = new SwaggerClientApiDefaultApi();
$param = new SwaggerClientModelParam(); // SwaggerClientModelParam 为您在Swagger规范文件中定义的参数模型类
$param->setId(1);

try {
    $result = $apiInstance->getOperation($param);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->getOperation: ', $e->getMessage(), PHP_EOL;
}

PHP サーバー コードを生成した場合は、 Swagger の仕様 API リクエストを処理するためにファイルに定義されたルート。

概要

Swagger Codegen を使用して、PHP API クライアントおよびサーバー コードを簡単に生成します。これを使用する前に、Swagger 仕様ファイルを作成し、必要な API 操作とパラメーターがすべて含まれていることを確認してください。次に、Swagger Codegen ツールを使用して、API の使用を開始するためのコードを生成するだけです。

以上がSwagger Codegen を使用して PHP で API クライアントおよびサーバー コードを生成する方法の詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。