パラメーターの作成

パラメーターは、URL パス、照会パラメーター、ヘッダー、または要求本文の変数要素を定義します。 API 定義では、パスおよびパス操作のパラメーターを作成できます。

開始前に

パラメーターの作成ウィンドウを起動します。 パラメーターを作成できる API 定義内の領域の詳細については、以下のトピックを参照してください。

このタスクについて

注: このタスクは、 OpenAPI 2.0 API 定義の構成に関連しています。 OpenAPI 3.0 API 定義の構成方法について詳しくは、 OpenAPI 3.0 API 定義の編集を参照してください。

このタスクは、 API Designer UI アプリケーションを使用するか、ブラウザー・ベースの API Manager UI を使用して実行できます。

パラメーターはヘッダーに似ていますが、以下の点が異なります。
  • パラメーターには実際のデータが含まれており、エンド・ユーザーに対して使用可能ですが、ヘッダーには要求または応答に関連付けられたメタデータが含まれており、エンド・ユーザーに対して表示されません。
  • パラメーターはさまざまな位置に配置できますが、ヘッダーの位置は常に header に設定されます。
  • パラメーターにはさまざまな形式スタイルを設定できますが、ヘッダーのスタイルは常に simple です。

いつでも、 「ソース」 アイコン OpenAPI ソース・アイコンをクリックして、基礎となる OpenAPI YAML ソースに直接切り替えることができます。 設計フォームに戻るには、 「フォーム」 アイコン フォーム・アイコンをクリックします。

手順

  1. 以下の情報を指定します。
    • 「パラメーター名」: パラメーターの名前。
      注意: クエリ・パラメータ名に "+"特殊文字が含まれる場合、%20（リテラル・スペース文字）の代わりに%2B（リテラル・プラス文字）としてエンコードされます。 したがって、クエリパラメータをインバウンドの URL と照合するために、エンコードされた値が使用されます。 例えば、クエリパラメータの名前が a+space の場合、受信メール URL で一致させる値は a%2Bspace となります。
    • Located In: パラメーターの場所。 次のオプションのいずれかを選択します:
      • 照会: URL に付加されるパラメーター。 例えば、url_path?myparam=myvalueです。
      • ヘッダー: 要求の一部として予期されるカスタム・ヘッダー。
      • パス ：パラメータ値は、操作の URL の一部であり、{}で囲まれています。
      • body: POST、PUT、および PATCH 要求の本体を記述するパラメーター。
    • 「説明」: パラメーターの説明。
    • タイプ: パラメーターのデータ・タイプ。
    • フォーマット: データ・フォーマットを選択します。使用可能なオプションは、選択した 「タイプ」によって異なります。
    • 必要に応じて、以下のオプションを選択します。
      • 必須: このパラメーターが必須かどうかを決定します。 「場所」プロパティーが「パス」に設定されている場合は、このオプションを選択する必要があります。
      • 空の値を許可: 空の値を使用してパラメーターを送信できます。 これは、「場所」プロパティーが「照会」に設定されている場合にのみ有効です。
  2. 「作成」をクリックします。
    パラメータの編集を参照してください。