通常、プロジェクトは、特定の目標に向かって複数のパートナーが協働して開発します。利害関係者間の相互依存により各メンバーの作業が制限され、プロセス中に誤解が生じて開発プロセスに悪影響を及ぼしたり、プロジェクトのスケジュールに影響を与ぼしたりすることもあります。プロジェクト開発サイクルの初期段階で Mock を使用することで、作業やプロジェクトの結果をシミュレートできます。この結果、プロジェクト開発中にチームメンバー間の伝達ミスや誤解が大幅に減少し、開発効率が向上します。
API Gateway は、Mock モードでの簡易設定をサポートしています。
Mock の設定
Mock を設定するには、[API 編集] > [基本バックエンド定義] をクリックします。
1. Moc レスポンス結果の入力
Mock レスポンス結果フィールドに実際のレスポンス結果を入力できます。JSON、XML、またはテキスト形式の Mock レスポンス結果がサポートされています。例:
"result"
:title":"Mock test for API Gateway
Mock 設定を保存し、ニーズに応じてテスト環境か本番環境にリリースしてデバッグします。API デバッグページでデバッグすることもできます。
2. レスポンスの statusCode の入力
次の表に、statusCode の有効な値を示します。HTTP 1.1 レスポンスステータスコードの形式とステータスがサポートされています。次の表にない statusCode を指定すると、パラメーターが無効であることを示すエラーが報告されます。
http コード | http メッセージ |
---|---|
200 | OK |
201 | Created |
202 | Accepted |
203 | Non-Authoritative Information |
204 | No Content |
205 | Reset Content |
206 | Partial Content |
300 | Multiple Choices |
301 | Moved Permanently |
302 | Found |
303 | See Other |
304 | Not Modified |
305 | Use Proxy |
306 | (Unused) |
307 | Temporary Redirect |
400 | Bad Request |
401 | Unauthorized |
402 | Payment Required |
403 | Forbidden |
404 | Not Found |
405 | Method Not Allowed |
406 | Not Acceptable |
407 | Proxy Authentication Required |
408 | Request Timeout |
409 | Conflict |
410 | Gone |
411 | Length Required |
412 | Precondition Failed |
413 | Request Entity Too Large |
414 | Request-URI Too Long |
415 | Unsupported Media Type |
416 | Requested Range Not Satisfiable |
417 | Expectation Failed |
450 | Parameter Requried |
451 | Method Connect Exception |
500 | Internal Server Error |
501 | Not Implemented |
502 | Bad Gateway |
503 | Service Unavailable |
504 | Gateway Timeout |
505 | HTTP Version Not Supported |
3. Mock ヘッダーの定義
API Gateway は、カスタム Mock ヘッダーと、重複するヘッダー名をサポートしています。ヘッダー名の値を空にすることはできず、数字、文字、アンダースコア (_)、ハイフン (-) のみを含めることができます。ヘッダーの値を空にすることはできません。
Mock の削除
Mock を削除するには、別のバックエンドサービスを設定します。Mock レスポンス結果の値は削除されないので、その値を次の Mock 設定で使用できます。変更をリリースする必要があります。変更は、リリース後に有効になります。