クラシックスキーマバリデーション

API Shieldインターフェースを使用して、提供されたAPIスキーマに従ってリクエストを検証するAPIスキーマバリデーションを設定します。

APIのスキーマバリデーションを設定する前に、私たちの仕様に一致するAPIスキーマファイルを取得する必要があります。

スキーマバリデーション2.0ベータ版に参加している場合、設定を変更することはできますが、新しいクラシックスキーマバリデーションスキーマを追加することはできません。

ノート

この機能は、エンタープライズプランの顧客のみが利用可能です。アクセスを取得するには、Cloudflareのカスタマーサクセスマネージャーに連絡してください。

スキーマバリデーションを使用したAPI Shieldの作成

Cloudflareダッシュボードでスキーマバリデーションを設定するには：

1. Cloudflareダッシュボード ↗にログインし、アカウントとドメインを選択します。
2. セキュリティ > API Shieldを選択します。
3. スキーマバリデーションに移動し、スキーマを追加を選択します。
4. ポリシーの説明的な名前を入力し、オプションでスキーマバリデーションをトリガーするための式を編集します。たとえば、APIがhttp://api.example.com/v1で利用可能な場合、Hostnameフィールドがapi.example.comに等しいことを確認し、URI Pathフィールドに対して正規表現を使用してチェックを行います — 正規表現^/v1に一致します。

重要

ホスト名を検証するには、ルールにHostnameフィールドを明示的に含める必要があります。たとえホスト名の値がスキーマファイルに含まれていても、無視されます。

5. 次へを選択します。
6. スキーマファイルをアップロードします。
7. 保存を選択して、スキーマファイルの内容を検証し、スキーマバリデーションルールを展開します。検証エラーが発生した場合は、サポートされているファイル形式のいずれかを使用していることを確認し、各エンドポイントとメソッドのペアに一意の操作IDがあることを確認してください。

API Shieldルールを展開した後、Cloudflareは保護レベルと非準拠および未保護リクエストに対して発生するアクションによって整理されたすべてのAPIエンドポイントの概要を表示します。

1. エンドポイントアクションのドロップダウンで、保護されたエンドポイントをターゲットにし、スキーマバリデーションに失敗したすべてのリクエストに対するアクションを選択します。
2. フォールスルーアクションのドロップダウンで、未保護のエンドポイントをターゲットにするすべてのリクエストに対するアクションを選択します。
3. オプションで、スキーマが保存されると同時にエンドポイントをエンドポイント管理に保存することができます。**エンドポイント管理**に新しいエンドポイントを保存を選択します。エンドポイントは、スキーマがドラフトとして保存されるか、ライブで公開されるかに関係なく保存されます。
4. 完了を選択します。