MockAPI-PHP

English GitHub
PHP Version License GitHub release GitHub issues GitHub last commit

このツールはPHP開発者向けの軽量モックAPIサーバーで、迅速なプロトタイピング、テスト、APIファースト開発向けに設計されています。
MockAPI-PHP を使用すると、実際のバックエンドを必要とせずに、JSON またはテキスト ファイルを使用して RESTful API レスポンスをシミュレートできます。

レスポンスデータに基づくOpenAPI 3.0スキーマの自動生成をサポートします。

このツールを使用する理由

  • シンプルかつ迅速にセットアップできる ローカルモック API サーバー が必要な場合。
  • ファイルベースのモック が必要な場合（GUI やコードのコンパイルは不要）。
  • 柔軟な動的レスポンス、カスタム遅延、またはエラーシミュレーションが必要な場合。
  • 実際のモックレスポンスから OpenAPI 仕様を自動生成 したい場合。

最適な用途

  • フロントエンドとバックエンドの統合を構築またはテストする PHP 開発者。
  • 実サーバーに依存せずに API レスポンスをテストする QA チーム。
  • Swagger、Prism、Postman などのツールを使用して API ファーストワークフロー を使用するチーム。

機能概要

  • エンドポイントの自動登録 - responses/ フォルダをスキャンして自動登録。
  • 動的レスポンスの読み込み - JSON やテキストレスポンスに対応。
  • ポーリング対応 - リクエスト回数に応じたレスポンス変更。
  • カスタムレスポンス - クエリパラメータでレスポンスを切り替え可能。
  • エラーレスポンス - 404 などのエラーレスポンスを定義可能。
  • レスポンス遅延 - 遅延レスポンスに対応。
  • カスタムフック - 任意のレスポンスを動的にオーバーライド可能。
  • OpenAPI対応 - 作成したレスポンス構成をOpenAPI 3.0スキーマとして自動生成可能。
  • ログ出力 - リクエストやエラーログを記録。
  • 環境変数設定 - vlucas/phpdotenv による設定管理。

動作環境

  • PHP 8.3+
  • Composer

ユニットテスト

このプロジェクトの基本的な動作についてはユニットテストを定義しています。 必要に応じてテストケース（ tests/MockApiTest.php ）を拡張することでテストを追加することが可能です。

テストの実行:

php vendor/bin/phpunit

ライセンス

このプロジェクトは MIT License のもとで公開されています。

著作者