1.8. マッピングルールの定義
マッピングルールは、API へのアクセスをトラッキングおよび制限するために、エンドポイントへの呼び出しを定義したメソッドおよびメトリクスに関連付けるものです。マッピングルールは、バックエンドレベルおよびプロダクトレベルで定義できます。バックエンドレベルでマッピングルールを定義することのメリットは、複数のプロダクトにバックエンドを追加できることです。(プロダクトレベルおよびバックエンドレベルの両方で) API に対するリクエストに基づいて使用状況に関する情報を収集するメトリックまたはメソッドの詳細は、3scale API Management API の使用状況を把握するために APIcast がマッピングルールをどのように適用するか を参照してください。
前提条件
- バックエンド。バックエンドの作成については、プロダクトに追加するバックエンドの作成 を参照してください。
手順
- Dashboard で、マッピングルールを定義する Backend をクリックします。
- ナビゲーションパネルで Mapping Rules をクリックします。
- Create mapping rule をクリックします。
以下の設定を指定します。
Verb
HTTP リクエストの動詞 (
GET、POST、DELETE、またはPUT)。パターン
照合するパターン。例:
/helloなど。Metric or method to increment
メトリックまたはメソッドの名前。
Increment by
メトリックのカウントを増やす数。たとえば、
1と設定します。Last?
リクエストが Last? とマークされたルールに一致する場合、APIcast は処理を停止し、残りのマッピングルールでの一致を検索しません。その後、メトリクスのインクリメントも停止します。
Position
マッピングルール実行の順番を表す数字。マッピングルールの並べ替えに使用します。
- Create mapping rule をクリックします。
次のステップ
これらの手順を完了すると、バックエンド にマッピングルールが追加されます ([Your_API_backend] > Mapping Rules)。このマッピングルールは、現在そのバックエンドを使用している各プロダクトでも利用できます。マッピングルールをプロダクトレベルでアクティブにするには、[Your_product_name] > Integration > Configuration の順に移動し、Products タブで最新の設定をプロモートします。
例
設定をプロモートすると、3scale はバックエンドのマッピングルールをプロダクトレベルでアクティブ化します。マッピングルールは、プロダクトで指定したバックエンドパスに続きます。たとえば、以下のような設定があるとします。
-
バックエンドでのマッピングルールのパターン:
/thousands -
バックエンドをプロダクトに追加する際のパス:
/unitprice
この場合、プロダクトレベルでのマッピングルールは、/unitprice/thousands となります。
