flight php swaggerダウンロード - flight php swaggerソースコードのダウンロード

flight php swagger

パイソン

v0.6.2

ダウンロード

フライト/Swagger バンドル

Swagger、PHPUnit、その他の便利なユーティリティがバンドルされたフライトマイクロフレームワーク。基本的なプロジェクト設定、テストルートとモデル、単体テスト用のテンプレートを含めることにより、前述のツールで構築された API の開発を開始できるように設計されています。

はじめる

前提条件

このガイドは、プロジェクトで次のテクノロジを現在使用している (または使用する予定がある) ことを前提としています。

PHP 7.1+
作曲家
Xdebug (PHPUnit を使用する場合は必須)

インストール中

まず、PHP 7.1 以降を使用して実行中の Web サーバー (Apache など) をインストールおよび構成していることを確認します。
composerを使用してプロジェクトのスケルトンをダウンロードし、必要な依存関係をすべてインストールし、サンプル単体テストを実行します。
composer create-project tribeos/flight-php-swagger path/to/project

URL書き換えを有効にする

Flight が機能するには Apache 2 のmod_rewriteモジュールに依存しているため、まずa2enmod経由で有効にしてからサーバーを再起動する必要があります。

sudo a2enmod rewrite

sudo systemctl restart apache2

その後、Apache のデフォルト設定ファイルも編集する必要があります。これは、書き換えルールを適用するために.htaccessファイルを使用することが最初は禁止されているためです。設定ファイルは通常、 /etc/apache2/apache2.confにあります。その中で、ディレクトリ/var/wwwを参照するブロックを見つけて、 AllowOverrideがAllに設定されていること、およびRequire all grantedことを確認します。

 <ディレクトリ /var/www/>オプション インデックス FollowSymLinksAllowOverride AllRequire すべて許可
</ディレクトリ>

変更を保存した後、Apache サーバーを再起動します。

複数のサイト構成がある場合、または複数のサイト構成が必要な場合は、 /etc/apache2/sites-available内の目的の構成ファイルを編集することで、サイトごとに書き換えルールを有効にすることもできます。詳細については、次のチュートリアルを参照してください。

注: 前述の手順は、Ubuntu ディストリビューションを使用していることを前提としています。別のオペレーティングシステムを使用している場合は、書き換えモジュールの有効化に関する適切なチュートリアルを参照してください。

Windows (WAMP/XAMPP)
CentOS

不足している PHP 拡張機能をインストールする

プロジェクトとその依存関係には、特定の PHP 拡張機能がインストールされている必要があります。不足している可能性がある一般的な拡張機能は、次のようなものである可能性があります。

問題	解決
`mbstring`	`sudo apt install php-mbstring`
`zip`および`unzip`関連の問題	`sudo apt install zip unzip php-zip`

注: 前の Apache 2 セクションと同様に、これらの手順は Ubuntu ディストリビューションに関連しています。別のオペレーティングシステムを使用している場合は、適切な代替コマンドを参照してください。

プロジェクトの構造

インストールが完了すると、プロジェクト内に次の構造が表示されます。

path/to/project
├── app 
│   ├── models
│   │   └── SampleModel.php
│   ├── routes
│   │   ├── FlightSetup.php
│   │   └── SampleRoute.php
│   └── utils
│       └── Validator.php
├── config
│   ├── config.php
│   └── config.sample.php
├── docs
├── logs
│   └──  .htaccess
├── tests
│   ├── build
│   └── unit
│       └── SampleTest.php
├── vendor
├── .gitignore
├── .htaccess
├── autoload.php
├── composer.json
├── composer.lock
├── index.php
├── LICENSE
├── phpunit.xml
└── README.md

プロジェクトの主要コンポーネントの概要:

app : メインアプリケーションフォルダー

models : リクエスト/レスポンスに使用されるモデル
routes : API ルートの定義
utils : バリデータやロガーなどのアプリケーションユーティリティ

config : 設定ファイル
docs : Swagger ドキュメントファイル
logs : ログストレージ
tests : アプリケーションテストフォルダー

build : フォームテスト (コードカバレッジなど) の結果として得られるコンパイル済みファイル
src : テストソースファイル

vendor : すべてのライブラリとサードパーティコードの場所
autoload.php : Composer の依存関係をロードし、他のすべてのプロジェクトファイルを含むブートストラップファイル
index.php : API エントリポイント
phpunit.xml : PHPUnit テスト構成

プロジェクトに取り組んでいます

プロジェクト構成

プロジェクト (および Swagger ドキュメント) に関連するすべての主要な設定は、 config/config.phpファイル内で処理されます。プロジェクトのニーズに応じて構成定数を変更/追加します。

もう 1 つの重要なファイルは、API エントリポイントとして機能するindex.phpです。ファイルautoload.phpが必要です。このファイルには、Composer の依存関係をロードするコードと、その他すべての必要なプロジェクトファイルが含まれています。さらに、Flight フレームワークを開始します。デフォルトでインポートされるファイルは、すべてのmodels 、 routes 、 utilsに加え、プロジェクト構成ファイル ( config/config.php )、Swagger-PHP 構成ファイル ( docs/swagger.php )、および Composer のvendor/autoload.phpです。プロジェクトのニーズに応じて、インポートするファイルを変更/追加します。

フライト

Flight は、RESTful Web API を迅速に作成できる、拡張可能で使いやすい PHP フレームワークです。これにより、ミドルウェア機能やカスタムメソッドをオーバーライド/作成する機能と組み合わせて、詳細で機能的な API エンドポイントを作成できます。

 Flight::route('GET /sample/@value', function($value) {
    Flight::json([ 'sample_value' => $value ]);
});

プロジェクト内のすべてのルーティングは Flight 経由で行われます。初期のフライト設定 ( FlightSetup.php ) とすべてのプロジェクトルートは、 routesフォルダー内で処理され、ニーズに合わせて変更できます。

Flight に関する広範な使用法ドキュメントと例は、Flight ホームページの「学習」エリアで入手できます。 Flight フレームワーク自体の詳細については、その GitHub リポジトリにアクセスしてください。

Swagger-PHP

routesフォルダーにルートを作成したら、RESTful API の OpenAPI ドキュメントの作成と生成を開始できます。

ドキュメントは、対応するルートの上にあるDocBlocks (別名 PHP コメントブロック) 内に書き込まれます。

 /** * @OAGet( * path="/sample/route", * tags={"sample"}, * summary="サンプル ルート。", * @OAResponse( * response=200, * description="Aサンプル応答。" * ), * security={ * {"api_key": {}} * } * )*/

すべての RESTful エンドポイントに対して、パス、タグ、短い概要、パラメータ、デフォルトのパラメータ値、リクエスト本文、利用可能なレスポンス、セキュリティ認証、およびその他の多数のオプションを定義できます。

プロジェクト名、プロジェクト作成者、API サーバー URL、仕様フォルダーなどの一般的な Swagger 構成は、 config/config.phpの「Swager 構成定数」領域にあり、構成できます。

プロジェクトのスケルトンには、Swagger ドキュメントに必要なすべてのファイル (PHP セットアップファイル、HTML および CSS) が含まれるdocsフォルダーが付属しています。ドキュメントにアクセスするには、ブラウザーでプロジェクトのルートルート ( / ) に移動します。

Swagger 全般および OpenAPI 標準の詳細については、Swagger の公式ホームページを参照してください。 PHP 実装に関する広範な使用法ドキュメントと例は、swagger-php 公式ホームページで入手できます。

プロジェクトユーティリティ

ロガー

このプロジェクトには、HTTP リクエスト、レスポンス、エラーロガーである http-logger がバンドルされており、(デフォルトでは) すべての受信リクエストとそれに対応するレスポンスをタブ区切り値 (TSV) としてlogs/debug.logに記録します。ロガーの詳細情報と構成の詳細については、GitHub ページを参照してください。

ロガーにはログファイルの場所が必要です (デフォルトでは、 config/config.phpの定数によって設定されます)。さらに、ロガーの機能を最大限に活用するには、Flight の内部エラーハンドラーを無効にする必要があります (有効にすると、http-logger の前に特定の種類のエラーが捕捉されます)。

 /* FlightPHP の内部エラー ロガーを無効にします。 */Flight::set('flight.handle_errors', false);
HttpLogger::create('file', 'full+h', LOG_FILE, false);/* ロガーを取得して使用します */$logger = HttpLogger::get();$logger->log();

ロガーは、 routes/FlightSetup.phpを介して組み込まれ、フライトミドルウェア関数Flight::after()内に構成されます。この関数は、すべてのリクエストの後に実行されます (そのため、適切な応答を取得できます)。開示に応じて、ロガーの機能と監視するルートを変更できます。

`Flight::output()`

Flight::output()はFlight::json() (JSON 応答出力) の機能とカスタム HTTP Logger を組み合わせたカスタムマップされたメソッドです。このメソッド経由で送信される API 応答は、ロガーで設定された設定に従って自動的に記録されます。このメソッドは、 routes/FlightSetup.phpで定義および構成されます。

これは、Flight ミドルウェアを使用してインターセプトせずに、リクエスト/レスポンスのペアのログ機能が必要な場合に便利です。

Flight::output()送信される実際のデータ (必須) と応答コード (オプション、デフォルトでは 200) の 2 つのパラメーターを取ります。

 Flight::output(['sample_message' => 'サンプル応答。'], 301);

`Flight::validate()`

Flight::validate() Swagger-PHP 分析を使用して、渡されたリクエスト本文が、予期される OpenAPI モデル仕様に従って有効である (すべての必須属性を含む) かどうかを判断します。

すべてのモデルはクラスとして宣言され、その属性は public に設定されます。モデルはapp/modelsで定義され、次の構造に従います。

 /** * @OASchema( * ) */class SampleModel {/** * @OAProperty( * description="リクエストボディのサンプル属性。", * example="サンプル文字列。" * required=true * ) * @ var string */public $sample_attribute;
}

この具体的な例では、 descriptionモデルのプロパティの概要を説明するために使用され、 requiredプロパティが必須かどうかを決定し、 exampleプロパティにデフォルト値を割り当てます。モデルスキーマの詳細については、Swagger-PHP のドキュメントを参照してください。

モデルバリデータクラスはutils/Validator.phpで宣言および定義され、カスタムマップされた Flight メソッドとしてroutes/FlightSetup.phpに含まれます。これは 2 つのパラメーターを取ります。リクエスト本文が検証されるクラスとリクエスト本文自体です。

 Flight::validate(SampleModel::class, Flight::request()->data->getData());

このメソッドは、追加のメソッドが呼び出される前に、API ルート内で呼び出される必要があります。モデルが有効な場合、リクエストは実行を続行します。モデルが検証に失敗した場合、 400 Bad Request応答コードが出力され、リクエストが終了します。

注: Flight::validate() Flight::output()に依存するため、プロジェクトからカスタム出力メソッドを削除する予定がある場合は、必要に応じてバリデーターがマップされたメソッドを書き直す必要があります。

プロジェクトのテスト

このプロジェクトには、PHP のテストフレームワークである PHPUnit が付属しており、それ自体のテストに加えて、コードカバレッジの生成も可能です。

テストセットアップ

PHPUnit を使用したテストに関連するすべての設定はphpunit.xmlにあります。セットアップにはいくつかのオプションが使用できます。

テストファイルの場所testsuitesタグ内で、テストのためにスキャンされる場所を定義できます。デフォルトでは、これはtests/unitです。テストディレクトリが ( directoryタグ経由で) 定義されると、テスト実行中にテストファイルがアルファベット順に実行されます。必要に応じて、 fileタグを使用してカスタムオーダーでテストファイルを定義することもできます。

    <テストスイート>
        <testsuite name="サンプル-テストスイート">
            <directory suffix="Test.php">tests/src/</directory><!-- デフォルトでは、テスト ファイルはアルファベット順のファイル順序で実行されます。特定の実行順序を設定する場合は、個別のテスト ファイルを定義します --><!-- <file>tests/src/SampleTest.php</file> --></testsuite>
    </テストスイート>

テストカバレッジレポートの種類テストの実行後に、さまざまな種類のテストレポートを生成できます。ログの種類はloggingタグで定義されます。コンパイルされたすべてのテストファイルは、デフォルトでは、 tests/build内に配置されます。

    <logging><!-- テスト ログの種類 --><log type="testdox-html" target="tests/build/testdox.html"/>
        <log type="tap" target="tests/build/report.tap"/>
        <log type="junit" target="tests/build/report.junit.xml"/>
        <log type="coverage-html" target="tests/build/coverage"/>
        <log type="coverage-text" target="tests/build/coverage.txt"/>
        <log type="coverage-clover" target="tests/build/logs/clover.xml"/>
    </ロギング>

コードカバレッジレポートに含める/除外するファイルコードカバレッジレポートに含める (またはコードカバレッジレポートから除外する) ファイルを選択することもできます。これは、 whitelistタグ内のfilterタグを通じて行われます。デフォルトでは、プロジェクトの PHPUnit セットアップは、 modelsとroutesを除くappディレクトリ内のファイルをカバーします (これらのフォルダーにはコードカバレッジを効果的にテストできるコードが含まれていないため)。カスタムの包含/除外フォルダーおよびファイルを定義することもできます。

    <フィルター>
        <whitelist><!-- コード カバレッジに使用するフォルダーの名前 --><directory suffix=".php">app/</directory>
            <exclude><!-- コード カバレッジから除外されるファイル/フォルダー (テスト可能なメソッドのない PHP ファイル)。プロジェクトのニーズに応じて編集します。 --><directory suffix=".php">app/models</directory>
                <directory suffix=".php">app/routes</directory>
            </除外>
        </ホワイトリスト>
    </フィルター>

テストを書く

すべての単体テストは、デフォルトで、 tests/unitディレクトリ内に書き込む必要があります。テストファイル名は、 ( phpunit.xmlで定義されているように) PHPUnit で検出できるように、 Test.phpで終わる必要があります (例: SampleTest.php )。

テストクラスはTestCaseクラスを拡張して定義され、さまざまなテストメソッドを含めることができます。テストに名前を付けるときは、 test + キャメルケースでのテストの説明 (例: testThisIsASampleTest ) という規則を使用できます。これにより、テスト実行中にテストケース名を説明文に変換できるようになり、テストで何を行うべきかについて開発者に追加の概要が提供されます。

 /* testing/unit/SampleTest.php */<?phpuse PHPUnitFrameworkTestCase;class SampleTest extends TestCase {public function testThisIsASampleTest() {$this->assertTrue(true);
    }
}

テストの実行

すべてのテストを実行するには、プロジェクトのルートディレクトリ内でvendor/bin/phpunit --testdoxを実行します。

 root@ubuntu:/path/to/project$vendor/bin/phpunit --testdox
PHPUnit 7.5.16、Sebastian Bergmann および寄稿者による。

サンプル
  これはサンプルテストです

単一のテストファイルのみを実行するには、そのパスを指定します: vendor/bin/phpunit --testdox tests/unit/SampleTest.php

--testdoxフラグはオプションですが、(上記のセクションで説明したように) 名前に基づいてテストに関する説明文を生成し、テスト内で何が起こっているかを理解しやすくするため、推奨されます。

テストの実行後、コードカバレッジレポートがtests/build/coverageディレクトリ内に生成され、ブラウザでこのパスを開くと表示できます。

著者

Aldin Kovačević 、スケルトンとドキュメントに関する初期作業- Aldin-SXR

ライセンス

スケルトンは MIT ライセンスに基づいてライセンスされています。詳細については、LICENSE ファイルを参照してください。

作業中です。

拡大する

追加情報

バージョン v0.6.2
タイプパイソン
更新時間 2025-01-07
サイズ 2.37MB
から Github

flight php swagger

フライト/Swagger バンドル

はじめる

前提条件

インストール中

URL書き換えを有効にする

不足している PHP 拡張機能をインストールする

プロジェクトの構造

プロジェクトに取り組んでいます

プロジェクト構成

フライト

Swagger-PHP

プロジェクトユーティリティ

ロガー

`Flight::output()`

`Flight::validate()`

プロジェクトのテスト

テストセットアップ

テストを書く

テストの実行

著者

ライセンス

php jwt

baiduwp php

web php

stripe php

swagger codegen

ダイスフライトゲーム

chat.petals.dev

GPT Prompt Templates

GPTyped

Nuitka

azure storage python

Google ブログコンバーター (ブログデータコンバーター)

wp functions

waymo open dataset

slugify