すべてのプロダクト
Search
ドキュメントセンター

API Gateway:フロントエンド入力パラメータ

最終更新日:Nov 10, 2025

説明

フロントエンド入力パラメーターの情報項目のタイプを一覧表示します。

ノード名

RequestParameter。

サブノード

パラメーター名 種類 説明
ApiParameterName String パラメーター名。
位置 String パラメーターの場所; 値: BODY、HEAD、QUERY、およびPATH。
ParameterType String パラメーター型; 値: String (文字型) 、Int (整数型) 、Long (長整数型) 、Float (単精度浮動小数点型) 、Double (倍精度浮動小数点型) 、およびBoolean (ブール型) 。
必須/任意 String 必須かどうか; 値: Required (必須) およびOPTIONAL (オプション) 。
DefaultValue String デフォルト値。
DemoValue String 例。
MaxValue Long ParameterTypeがInt、Long、Float、またはDoubleに設定されている場合の最大パラメーター値。
MinValue Long ParameterTypeがInt、Long、Float、またはDoubleに設定されている場合の最小パラメーター値。
MaxLength Long ParameterTypeがStringに設定されている場合の最大パラメーター長。
MinLength Long ParameterTypeがStringに設定されている場合の最小パラメーター長。
RegularExpression String ParameterTypeがStringに設定されている場合のパラメーター検証 (正規表現) 。
JsonScheme String ParameterTypeがStringに設定されている場合のJSON検証 (JSONスキーマ) 。
EnumValue String ParameterTypeがInt、Long、Float、Double、またはStringに設定されている場合に入力できるハッシュ値。 1、2、3、4、9、またはa、B、C、E、Fなど、さまざまな値をコンマで区切る必要があります。
DocShow String ドキュメントの可視性; 値: PUBLICおよびPRIVATE。
DocOrder Integer ドキュメントで注文します。
説明 String パラメーターの説明。