パラメーターは、URL パス、照会パラメーター、ヘッダー、または要求本文の変数要素を定義します。 API 定義では、パスおよびパス操作のパラメーターを作成できます。
開始前に
パラメーターの作成ウィンドウを起動します。 パラメーターを作成できる API 定義内の領域の詳細については、以下のトピックを参照してください。
このタスクについて
このタスクは、 API Designer UI アプリケーションを使用するか、ブラウザー・ベースの API Manager UI を使用して実行できます。
パラメーターはヘッダーに似ていますが、以下の点が異なります。
- パラメーターには実際のデータが含まれており、エンド・ユーザーに対して使用可能ですが、ヘッダーには要求または応答に関連付けられたメタデータが含まれており、エンド・ユーザーに対して表示されません。
- パラメーターはさまざまな位置に配置できますが、ヘッダーの位置は常に
header に設定されます。
- パラメーターにはさまざまな形式スタイルを設定できますが、ヘッダーのスタイルは常に
simple です。
ヘッダーについて詳しくは、
ヘッダーの作成を参照してください。
「ソース 」アイコン 
をクリックすると、いつでも直接、基盤となる OpenAPI のYAMLソースに切り替えることができます。 デザインフォームに戻るには、 フォームアイコンをクリックしてください 
。
手順
- パラメーターを作成します。最初からパラメーターを作成することも、パラメーター・コンポーネントで定義されているパラメーターを参照することもできます。
- 最初からパラメーターを作成するには、「定義」タブで以下の情報を指定します。
- 名前: パラメーター・コンポーネントを作成する場合に使用可能です。この名前は、API 定義内の他の場所からこのパラメーターを参照できるようにするためのキーを定義します。参照の形式は次のとおりです。
#/components/parameters/Name
注意：クエリ・パラメータ名に "+"特殊文字が含まれている場合、%20（リテラル・スペース文字）ではなく、%2B（リテラル・プラス文字）としてエンコードされます。 したがって、クエリパラメータをインバウンドの URL と照合するために、エンコードされた値が使用されます。 例えば、クエリパラメータの名前が a+space の場合、受信メール URL で一致させる値は a%2Bspace となります。
- パラメーター名 (必須): パラメーターの名前。
- 場所 (必須): パラメーターの場所。 次のオプションのいずれかを選択します:
- 照会: URL に付加されるパラメーター。 例えば、
url_path?myparam=myvalueです。
- ヘッダー: 要求の一部として予期されるカスタム・ヘッダー。
- パス ：パラメータ値は、操作の URL の一部であり、{}で囲まれています。
- Cookie: 特定の Cookie 値を API に渡すために使用されます。
- 「説明」: パラメーターの説明。 リッチテキストの表現には、 CommonMark 構文を使用できます。
- スタイル: パラメーター値のタイプに応じて、パラメーター値をどのようにシリアライズするかを記述します。 次のオプションのいずれかを選択します:
- matrix : RFC 6570 で定義されたパス形式のパラメータ。
- label : RFC 6570 で定義されたラベルのスタイルパラメータ。
- simple : RFC 6570 で定義されたシンプルなスタイルパラメータ。
- form : RFC 6570 で定義されたフォーム形式のパラメータ。
- spaceDelimited: スペースで区切られた配列値。
- pipeDelimited: スペースで区切られた配列値。
- deepObject: フォーム・パラメーターを使用してネストされたオブジェクトを簡単にレンダリングする方法を提供します。
- 必要に応じて、以下のオプションを選択します。
- 必須: このパラメーターが必須かどうかを決定します。 「場所」プロパティーが「パス」に設定されている場合は、このオプションを選択する必要があります。
- 非推奨: パラメーターが非推奨であり、使用されないようにする必要があることを指定します。
- 空値を許可: 空値を持つパラメーターの送信を許可します。 これは、「場所」プロパティーが「照会」に設定されている場合にのみ有効です。
- 展開: これを選択すると、タイプが
array または object のパラメーター値は、配列の各値、またはマップのキーと値のペアに対して別個のパラメーターを生成します。
- 「 予約文字を許可 」： RFC 3986 (
:/?#[]@!$&'()*+,;=) で定義されている予約文字を、パーセントエンコードせずにパラメータ値に含めることを許可するかどうかを指定します。 このプロパティーは、「場所」プロパティーが「照会」に設定されている場合にのみ適用されます。
- パラメーター・コンポーネントで定義されているパラメーターを参照するには、「参照」タブで以下の情報を指定します。
- 名前: パラメーター・コンポーネントを作成する場合に使用可能です。この名前は、API 定義内の他の場所からこのパラメーターを参照できるようにするためのキーを定義します。参照の形式は次のとおりです。
#/components/parameters/Name
注意：クエリ・パラメータ名に "+"特殊文字が含まれている場合、%20（リテラル・スペース文字）ではなく、%2B（リテラル・プラス文字）としてエンコードされます。 したがって、クエリパラメータをインバウンドの URL と照合するために、エンコードされた値が使用されます。 例えば、クエリパラメータの名前が a+space の場合、受信メール URL で一致させる値は a%2Bspace となります。
- パラメーター名 (必須。パス・パラメーターまたは操作パラメーターを作成する場合に使用可能): パラメーターの名前。
- 参照元 (Reference from): パラメーター・コンポーネントへの参照を選択します。
- 「作成」 をクリックします。