MockAPI-PHP

使い方

1. Composer のインストール

composer install

2. サーバーの起動方法

Mock API Server を起動するには、以下のいずれかの方法を利用してください。

推奨: start_server.php を使用 このスクリプトを使うと、環境変数 .env で指定した PORT を自動で反映し、temp/ 内の .txt ファイルもクリアされます。

php start_server.php

手動で PHP 内蔵サーバーを起動

php -S localhost:3030 -t .

3. APIリクエスト例

• GETリクエスト

  curl -X GET http://localhost:3030/api/users

• GETリクエスト（ポーリング対応）

  curl -b temp/cookies.txt -c temp/cookies.txt -X GET http://localhost:3030/api/users

• POSTリクエスト

  curl -X POST http://localhost:3030/api/users -H "Content-Type: application/json" -d '{"name": "New User"}'

• PUTリクエスト（データ更新）

  curl -X PUT http://localhost:3030/api/users/1 -H "Content-Type: application/json" -d '{"name": "Updated Name"}'

• DELETEリクエスト

  curl -X DELETE http://localhost:3030/api/users/1

• カスタムレスポンス

  curl -X GET "http://localhost:3030/api/users?mock_response=success"

• バージョン確認用

  curl -X GET http://localhost:3030/api/version

4. responses/ の設定方法

モックAPIのレスポンスは responses/ ディレクトリ内に JSON もしくはテキストファイルとして保存します。

• レスポンスの構成例

  responses/
  ├── products/
  │   ├── get/
  │   │   ├── default.json # デフォルトレスポンス（3～8回目と10回目以降のレスポンス）
  │   │   ├── 1.json # 1回目のリクエストで返すレスポンス
  │   │   ├── 2.json # 2回目のリクエストで返すレスポンス
  │   │   └── 9.json # 9回目のリクエストで返すレスポンス
  │   ├── post/
  │   │   ├── success.json # Product作成成功時のレスポンス
  │   │   └── 400.json # バリデーションエラー時のレスポンス
  │   ├── patch/
  │   │   └── success.json # Product更新成功時のレスポンス
  │   ├── delete/
  │   │   └── success.json # Product削除成功時のレスポンス
  │   └─…
  └─…

• エラーレスポンスの設定 例: responses/errors/404.json

  {
    "error": "Resource not found",
    "code": 404
  }

  例: responses/errors/500.txt

  Internal Server Error