DBAPI における API リクエストのパラメータ検証方法

実践

ケース1 — パラメータの文字列長が4文字以下であることを検証する

• 「パラメータ検証」項目で「新しいパラメータ検証ルールを追加」をクリックします。

• 検証スクリプトに JavaScript のコードを記述します。ここでは、name.length < 5 というコードを書き、失敗時のメッセージには適切な内容を入力します。このパラメータ検証ルールが通過しなかった場合、指定したエラーメッセージが返されます。

注意：JavaScript コードは複数行にわたって記述できますが、最終行が論理式（true や false を返す式）またはブール型変数であれば問題ありません。各行の末尾にはセミコロンを付けてください。例えば、var res = name.length < 5; res; のように記述できます。

また、コード内ではリクエストパラメータとして定義されたパラメータ名を直接参照できます。

• API を保存して公開します。
• インターフェースのリクエストテスト画面に移動し、長めの文字列を入力してリクエストを送信すると、エラーメッセージが表示されることが確認できます。

ケース2 — 複数のパラメータを同時に検証する

• API に複数のパラメータがある場合、各パラメータに対して個別に検証を設定できます。

「新規追加」ボタンをクリックすることで、任意の数のパラメータ検証ルールを追加できます。

ケース3 — 複数のパラメータ間での相互検証

ケース4 — 複雑なネスト構造を持つ JSON パラメータの検証

• application/json 形式の API パラメータについても、同様にパラメータ検証が可能です。

注意

• この機能は Enterprise Edition でのみ利用可能です。DBAPI Enterprise Edition のバージョン 4.1.0 で導入されました。