报告构建器 on DefectDojo Documentation

报告生成器

Mon, 01 Jan 0001 00:00:00 +0000

注意：可复用报告生成器（主题、块、模板以及已保存的生成报告）是 DefectDojo Pro 的功能，目前处于测试阶段。

DefectDojo Pro 报告生成器允许您使用可复用的组件来编写精美的报告，这样您只需构建一次组件即可在任何地方重复使用，而无需每次都从头开始构建报告。您可以通过侧边栏中的**📄 报告**区域访问它。

与开源版的比较

开源版 DefectDojo 可以构建报告、运行报告并让您获取输出，但它不会保存报告模板，也不会持久化保存您生成的报告。每份报告都是一次性的操作。

DefectDojo Pro 将报告功能转变为可复用的构建模块。您可以保存主题、块和模板，随意混合搭配、重复使用；您运行的每份报告都会作为生成报告持久化保存，供您日后下载或重新运行。Pro 版还通过完整的 REST API 公开整个工作流程，并支持 LLM 辅助创作，因此报告可以通过编程方式构建和运行。

使用 API 实现报告自动化

Mon, 01 Jan 0001 00:00:00 +0000

注意:Report Builder REST API(报告主题、区块、模板和生成的报告)是 DefectDojo Pro 的功能,当前处于测试版(beta)阶段。

报告构建器 REST API 可以让您自动化处理与在报告构建器 UI中手动组装时相同的主题、区块和模板 —— 而且它更进一步,让您可以运行模板并下载生成的 PDF 或 HTML 文件。本指南将带您走完完整的生命周期:进行身份验证、发现字段和过滤器的相关术语、创建各个构建模块,然后生成并获取报告。

使用 LLM 构建报告

Mon, 01 Jan 0001 00:00:00 +0000

注意：通过 REST API 和 LLM 自动化报告构建器是 DefectDojo Pro 的功能，目前处于测试阶段。

DefectDojo Pro 的报告构建器（主题、内容块和模板）完全由 REST API 驱动。这意味着您可以把整个任务交给 LLM 来完成：将一段自包含的提示词粘贴到 Claude、ChatGPT 或其他任何有能力的模型中，它会查询您租户的实时 OpenAPI 架构和 field_options，为您指定的受众提出一套主题以及可复用的内容块库和模板，生成一个可运行的 Python 脚本，然后运行报告并下载生成的文件。

使用报告生成器

Mon, 01 Jan 0001 00:00:00 +0000

DefectDojo 的报告生成器允许您使用一组内容小组件组装自定义报告、运行报告，并导出结果（例如打印为 PDF）。自定义报告可以汇总您希望与外部受众共享的发现项或端点，还可以包含品牌标识和样板文字。

注意： 在开源版 DefectDojo 中，构建报告、运行报告并获取其输出是一次性的操作。报告布局（模板）和生成的报告输出不会被保存在开源版中。若要重复使用某个布局，您需要在报告生成器中重新构建它。若要保存可重复使用的主题、块和模板，并保留生成报告的持久历史记录，请参阅 DefectDojo Pro 的报告生成器。

打开报告生成器

报告生成器可以通过侧边栏中的**📄 报告**页面打开。

报告生成器页面分为两栏。左侧的报告格式栏用于设计报告，您可以使用右侧可用小组件栏中的小组件。

第 1 步：设置报告选项

在报告选项部分，您可以执行以下操作：

为报告设置报告名称
在报告中包含用户创建的发现项备注
在报告中包含发现项图片
为报告上传页眉图片

为报告选择页眉图片

要在报告顶部添加图片，请点击选择文件按钮，将图片上传到 DefectDojo。