1.2.2. マッピングルールの照合

マッピングルールは前方一致で照合され、複雑な設定が可能です。表記法は OpenAPI および ActiveDocs の仕様に準じます。

  • マッピングルールは、スラッシュ (/) で始める必要があります。
  • 文字列 (例: /hello) を使用してパスの照合を行うことができます。

  • マッピングルールでは、クエリー文字列またはボディーにパラメーターを含めることができます (例: /{word}?value={value})。APIcast は以下のようにパラメーターを取得します。

    • GET メソッド: クエリー文字列から。
    • POST、DELETE、または PUT メソッド: ボディーから。
  • マッピングルールには名前付きワイルドカードを含めることができます (例: /{word})。このルールは、プレースホルダー {word} で定義する任意の文字にマッチします。たとえば、/morning のようなリクエストがルールにマッチします。ワイルドカードは、スラッシュとスラッシュの間またはスラッシュとピリオドの間に使用することができます。パラメーターにもワイルドカードを含めることができます。
  • デフォルトでは、指定したソート法に従ってすべてのマッピングルールが順番に評価されます。ルール /v1 を追加した場合には、パスが /v1 で始まるリクエストにマッチします (例: /v1/word または /v1/sentence)。
  • パターンの最後にドル記号 ($) を追加して、完全一致を指定することができます。たとえば、/v1/word$ は、/v1/word のリクエストにだけマッチし、/v1/word/hello のリクエストにはマッチしません。完全一致を指定する場合には、すべてにマッチするデフォルトのマッピングルール (/) を必ず無効にする必要があります。
  • 複数のマッピングルールがリクエストのパスにマッチする場合がありますが、マッチするルールがなければ、リクエストは無視され HTTP 404 ステータスコードが返されます。