1.8. マッピングルールの定義

API へのアクセスをトラッキングおよび制限するために、マッピングルールによりエンドポイントへの呼び出しを定義したメソッドおよびメトリクスに関連付けます。マッピングルールは、バックエンドレベルおよびプロダクトレベルで定義することができます。バックエンドレベルでマッピングルールを定義することのメリットは、複数のプロダクトにバックエンドを追加できることです。(プロダクトレベルおよびバックエンドレベルの両方で) API に対するリクエストに基づいて使用状況に関する情報を収集するメトリクスまたはメソッドについての詳細は、3scale API の使用状況を把握するために APIcast がマッピングルールをどのように適用するか を参照してください。

前提条件

手順

  1. Dashboard で、マッピングルールを定義する Backend をクリックします。
  2. ナビゲーションパネルで Mapping Rules をクリックします。
  3. Create mapping rule をクリックします。

  4. 以下の設定を指定します。

    • Verb: HTTP リクエストの動詞 (GET、POST、DELETE、または PUT)。
    • Pattern: 照合するパターン。たとえば、/hello 等。
    • Metric or method to increment: メトリクスまたはメソッドの名前
    • Increment by: メトリクスのカウントを増やす数。たとえば、1 等。
    • Last?: このマッピングルールを最後のルールとして、他のマッピングルールの処理を停止するかどうかを定義します。
    • Position: マッピングルール実行の順番を表す数字。マッピングルールの並べ替えに使用します。
  5. Create mapping rule をクリックします。

次のステップ

これらの手順を完了すると、バックエンド にマッピングルールが追加されます ([Your_API_backend] > Mapping Rules)。このマッピングルールは、現在そのバックエンドを使用している各プロダクトでも利用することができます。マッピングルールをプロダクトレベルでアクティブにするには、[Your_product_name] > Integration > Configuration の順に移動し、Products タブで最新の設定をプロモートします。

例

設定をプロモートすると、3scale はバックエンドのマッピングルールをプロダクトレベルでアクティブ化します。マッピングルールは、プロダクトで指定したバックエンドパスに続きます。たとえば、以下のような設定と仮定すると、

  • バックエンドでのマッピングルールのパターン: /thousands
  • バックエンドをプロダクトに追加する際のパス: /unitprice

プロダクトレベルでのマッピングルールは、/unitprice/thousands となります。