OpenAPI 仕様ファイルを使用したスキャン
OpenAPI 仕様ファイルを使用して OpenAPI を自動的にスキャンできます。これにより、パラメーターを更新してすべてのエンドポイントを含めることができるため、より適切なカバレッジが得られます。また、より正確かつ完全なスキャンが保証され、API 全体で潜在的な問題を特定することができます。
手順
- 「構成」>「API」に移動します。
- 「OpenAPI 仕様ファイル」を選択し、「仕様ファイルを追加」をクリックします。
-
URL を入力するか、「参照」をクリックしてローカル・ドライブからファイルを選択し、「続行」をクリックします。AppScan は、仕様ファイルの JSON または YAML 形式のみを受け入れます。
AppScan はデータを解析し、追加パラメーターの表にロードします。
- 自動的に入力されない場合は、ベース URL を設定します。
-
AppScan は探査中にパラメーターの値を自動的に検出しますが、スキャン中に値が自動的に検出できない場合には、パラメーターを手動で更新してパフォーマンスを向上させることができます。パラメーター値を関連する URL と一致させて編集します。
スキャン範囲を改善するためにパラメーターを更新し、すべてのエンドポイントがカバーされていることを確認し、要求の失敗を回避することを強くお勧めします。
-
必要に応じて API 認証を設定します。仕様ファイルに基づいて、「API キーの設定」または「基本認証の構成 (HTTP)」リンク (あるいはこの両方) が表示され、認証を設定できます。リンクが表示されない場合は、API キー、HTTP 認証、またはログイン管理 (ログインを記録または自動ログインを使用) を使用して認証を手動で設定できます。これにより、ほとんどのエンドポイントをカバーするスキャン・カバレッジが向上し、要求の失敗を回避できます。
AppScan が更新したパラメーター値を使用しない場合は、次の操作を実行できます。
- 「パラメーターの編集」ダイアログの「この値をすべてのパラメーターに適用」チェック・ボックスを選択します。
- 探査中に速度制限を超過するエラーが発生しないようにするには、「通信およびプロキシー」タブで「最大要求速度」を調整します。
-
構成が完了したら、スキャンを開始できます。
AppScan は自動スキャンを開始します。注: URL の代わりにローカル・ファイルを構成に追加すると、その仕様ファイルをテンプレートに含めることができなくなるため、そのファイルを SCANT (テンプレート) ファイルとしてエクスポートすることはできません。その仕様ファイルを削除するか、SCAN ファイルとして保存する必要があります。