使用 OpenAPI 规范文件扫描

您可以使用 OpenAPI 规范文件自动扫描 OpenAPI,这允许您更新参数并包括所有端点,从而提供更好的覆盖范围。这可确保更全面、更准确的扫描。

开始之前

注: 如果参数值是上载的文件,请参阅使用 Postman 集合进行扫描

过程

  1. 转到配置 > API
  2. 选择 OpenAPI 规范文件,然后单击添加规范文件
    注: AppScan Standard 不支持 OpenAPI 规范版本“3.1.0”。
  3. 输入 URL 或单击浏览以从本地驱动器中选择文件,然后单击继续。AppScan 仅接受 JSON 或 YAML 格式的规范文件。
    AppScan 会分析规范文件并在编辑附加参数表中显示检测到的 API 参数。
  4. 如果未自动填充,请配置基本 URL。
  5. AppScan 在探索过程中会自动检测参数的值,但在扫描过程中无法自动检测值的情况下,您可以手动更新参数以提高性能。通过将参数值与其相关的 URL 进行匹配,编辑参数值。
    注: 如果参数名称和值适用于所有端点,请在编辑参数对话框中选中将此值应用于所有参数复选框。
    建议更新参数以获得更好的扫描覆盖范围,确保覆盖所有端点并避免请求失败。
  6. 根据需要配置 API 认证。根据您的规范文件,将显示配置 API 密钥和/或配置基本认证 (HTTP) 链接以配置认证。如果未显示链接,您可以通过 API 密钥HTTP 身份验证登录管理(录制登录或使用自动登录)手动配置身份验证。
  7. 为避免在探索过程中出现超过速率限制故障,请调整通信和代理选项卡中的最大请求速率
  8. 配置完成后,便可启动扫描。
    AppScan 将启动自动扫描
    注: 如果将本地文件(而不是 URL)添加到配置中,则无法将其导出为 SCANT(模板)文件,规范文件不能包含在模板中。您必须除去规范文件或另存为 SCAN 文件。

下一步做什么

扫描完成后,您可以在自动填充表单页面上查看扫描期间找到的参数,还可以在数据页面上查看发送的请求和找到的参数。