时间戳

首页 > 解决方案 > Maven：如何测试目标文件夹中生成的文档是否正确生成？

maven - Maven：如何测试目标文件夹中生成的文档是否正确生成？

问题描述

我有一个使用 RestDocs 生成端点文档的 Java/Maven 项目。

对于未启动的 RestDocs，它所做的是在构建期间监视测试并使用来自测试的信息来生成“片段”，这些片段用于在 mvn 包阶段使用 asciidoc 创建 API 文档。

我面临的问题是，如果 asciidoc (.adoc) 文件引用了一个不存在的片段，则生成该文档并会说如下内容：

“myDoc.adoc 中未解决的指令 - 包括::{snippets}/error-example/response-fields.adoc[]”

由于这发生在测试之后，我不知道如何测试这样的东西，以便构建可以停止并让开发人员知道他们需要更新 .adoc 或片段。

任何指导将不胜感激。

标签： mavenjunitspring-restdocs

解决方案

当没有找到 .adoc 所期望的片段时，将其添加到 asciidoctor 插件的配置中会使构建失败：

<logHandler>
     <outputToConsole>true</outputToConsole>
          <failIf>
              <containsText>include file not found</containsText>
          </failIf>
</logHandler>

推荐阅读