API Shield の画面で API Schema validation を設定します。指定した API schema に従ってリクエストを検証します。
API に Schema validation を設定する前に、仕様 に合う API Schema ファイルを用意します。
Schema validation 2.0 を使っている場合は、設定の変更はできますが、Classic Schema validation のスキーマを新たに追加することはできません。
Cloudflare ダッシュボードで Schema validation を設定する手順は次のとおりです。
- Cloudflare ダッシュボード ↗ にログインし、アカウントとドメインを選びます。
- Security > API Shield を選択します。
- Schema validation を開き、Add schema を選択します。
- ポリシーに分かりやすい名前を入力し、必要に応じて Schema validation を起動する式を編集します。たとえば API が
http://api.example.com/v1で公開されている場合は、Hostname フィールドがapi.example.comと等しいことと、URI Path フィールドが正規表現^/v1に一致することを条件に含めます。
- Next を選択します。
- スキーマファイルをアップロードします。
- Save を選択し、スキーマファイルの内容を検証して Schema validation ルールをデプロイします。検証エラーが出た場合は、対応しているファイル形式 を使っていることと、各エンドポイントとメソッドの組み合わせに一意の operation ID があることを確認します。
API Shield ルールをデプロイすると、Cloudflare は保護レベルごとに整理した API エンドポイント の一覧と、スキーマに準拠しないリクエストおよび未保護のリクエストに対するアクションを表示します。
- Endpoint action のドロップダウンで、保護対象エンドポイントへのリクエストが Schema validation に失敗したときのアクションを選びます。
- Fallthrough action のドロップダウンで、未保護エンドポイントへのリクエストに対するアクションを選びます。
- 任意で、Save new endpoints to endpoint management を選ぶと、スキーマの保存と同時にエンドポイントを Endpoint Management へ保存できます。スキーマを下書きで保存する場合も、公開する場合も、エンドポイントは保存されます。
- Done を選択します。