パスとは、呼び出し可能な単位の REST API を指します。 パスは、HTTP 動詞と URL パスから成ります。 パスを構成することで、開発者への API の公開方法を定義します。
このタスクについて
このタスクは、 API Designer UI アプリケーションを使用するか、ブラウザー・ベースの API Manager UI を使用して実行できます。
このパスは、完全な URL を形成するためにサーバー URL に付加されます。 サーバーの構成について詳しくは、 API 用のサーバーの定義を参照してください。
いつでも、 「ソース」 アイコン 
をクリックして、基礎となる OpenAPI YAML ソースに直接切り替えることができます。 設計フォームに戻るには、 「フォーム」 アイコン 
をクリックします。
手順
- OpenAPI 3.0 API 定義の編集で説明されているように、編集のために API を開きます。
- 既に 1 つ以上のパスが定義されている場合は、 「パス」を展開します。
- 新規パスを作成するには、ナビゲーション・ペインの 「パス」 の横にある追加アイコン
をクリックします。 既存のパスを編集するには、ナビゲーション・ペインで対象のパスをクリックします。
- 以下の情報を指定します。
- パス: 個々のエンドポイントへの相対パス。
API にアクセスするための完全な URI を構成するために、このパスが基本パスに付加されます。 パスは、/文字で開始する必要がありますが、終了してはなりません。 パスの末尾のパラメーターには、1 つ以上のパス・レベルに一致する修飾子を含めることができます。
パラメーターの名前だけを指定すると、そのパスの 1 つのレベルが突き合わされます。 パスの複数のレベルを許可する場合は、パラメーターの前に以下のいずれかの修飾子を付けることができます。
- * は、0 個以上のオカレンスを示します。
- + は、1 つ以上のオカレンスを示します。
+ および * 修飾子は、パスの終わりでのみ使用できます。
例えば、以下のパスがあるとします。
/petstore/{type}/{*category}
以下のパスに一致します。ここでは、1 つのタイプ値のみが一致しますが、すべての (0 個以上の) カテゴリーが一致します。
/petstore/cats
/petstore/cats/supplies
/petstore/cats/supplies/health
/petstore/cats/supplies/health/medicines
/petstore/cats/supplies/health/medicines/a/b/c
- 参照 (既存のパスを編集する場合に使用可能): この OpenAPI 定義や外部ファイルなど、他の場所で定義されているパスへの参照。 参照を使用すると、この API やファイル (完全な API 定義または OpenAPI フラグメント) でパスに対して既に定義されている操作のセットを再使用できます。
参照は、JSON ポインター表記を使用します。 例えば、この API で
/mypath というパスへの参照は、次のような形式になります。
#/paths/~1mypath
文字
~1 は、文字
/ (特殊文字としてではなくパス名でリテラルとして使用されている) をエスケープするために使用されます。
path_fragments.yaml という外部ファイルで定義されているパスへの参照は、次のような形式になります。
file://path_fragments.yaml/paths/~1mypath
- 要約: オプションの要約。このパスのすべての操作に適用されます。
- 説明: オプションの説明。このパスのすべての操作に適用されます。 リッチ・テキスト表現には、 CommonMark 構文 を使用できます。
- 新規パスを作成する場合は、 「作成」をクリックします。
ステップ
4で説明されているように、さらに編集するためにパスの詳細が表示されます。
- 完了したら、 「保存」 をクリックします。