2. APIリクエスト時にヘッダーをつけてリクエストを送る

制御したい機能に応じて、接頭語「XG-DEBUG」で始まるヘッダーをつけてリクエストしてください。

ヘッダー名

概要

XG-DEBUG-WAIT-BEFORE

INT

XG側でリクエスト処理の 実行前 に指定されたウェイト(秒)を入れます

XG-DEBUG-WAIT-AFTER

INT

XG側でリクエスト処理の 実行後 に指定されたウェイト(秒)を入れます

XG-DEBUG-SKIP

BOOL

True であればリクエスト処理をスキップします。

XG-DEBUG-HTTPSTATUS

INT

強制的に「HTTP STATUS」の値を書き換えます。

XG-DEBUG-ERRORCODE

INT

エラーレスポンスが戻る時、強制的に「ERROR CODE」の値を書き換えます。

備考:ヘッダー名は大文字・小文字を区別しません。

ヘッダーの組み合わせの可否

ヘッダーの値によっては利用できない組み合わせがあります。

XG-DEBUG-SKIP が True の場合

XG側の処理はスキップされ、エラーを処理する目的に使用します。

XG-DEBUG-HTTPSTATUS

設定の可否

未設定

設定不可

200

設定不可

400/500

エラー書式で書き換え

XG-DEBUG-SKIP が False もしくは未定義の場合

XG側の処理が一度実行され、その後レスポンスのステータス・エラーコードが書き換えられます。

本来のレスポンスのステータスが正常系の場合(ステータスコードが200番台)

XG-DEBUG-HTTPSTATUS

設定の可否

未設定

変化なし

200

設定不可

400/500

エラー書式で書き換え

本来のレスポンスのステータスがエラーの場合(ステータスコードが400番台もしくは500番台)

XG-DEBUG-HTTPSTATUS

設定の可否

未設定

変化なし

200

設定不可

400/500

変化なし

レスポンスヘッダー

XG-DEBUG-HTTPSTATUS が有効になった場合、以下のレスポンスヘッダーが返却されます。

ヘッダー名

概要

XG-DEBUG-RESPONSE

BOOL

「HTTP STATUS」の値を XG-DEBUG-HTTPSTATUS の値に書き換えた場合、「TRUE」になります。

参考)デバッグヘッダーの挙動フローチャート