如何为spring-restdocs-asciidoctor指定自定义片段目录？

你只需要在构建工具的asciidoctor插件配置中指定snippetsDir属性，属性值和你通过RestDocumentationExtension配置的自定义片段目录路径保持一致即可，不同构建工具配置方式如下：

Gradle 项目配置 #

Groovy DSL（build.gradle） #

在build.gradle中添加如下配置：

asciidoctor {
    // 路径替换为你自定义的片段生成目录
    snippetsDir = file('build/custom-rest-snippets')
}

Kotlin DSL（build.gradle.kts） #

在build.gradle.kts中添加如下配置：

tasks.withType<Asciidoctor>().configureEach {
    // 路径替换为你自定义的片段生成目录
    snippetsDir.set(file("build/custom-rest-snippets"))
}

Maven 项目配置 #

在pom.xml中找到asciidoctor-maven-plugin插件，修改其configuration配置：

<plugin>
    <groupId>org.asciidoctor</groupId>
    <artifactId>asciidoctor-maven-plugin</artifactId>
    <version>2.2.2</version>
    <configuration>
        <!-- 路径替换为你自定义的片段生成目录 -->
        <snippetsDir>${project.build.directory}/custom-rest-snippets</snippetsDir>
        <attributes>
            <snippets>${snippetsDir}</snippets>
            <!-- 其余原有属性保持不变 -->
        </attributes>
        <!-- 其余原有配置保持不变 -->
    </configuration>
    <!-- 其余插件配置保持不变 -->
</plugin>

注意：配置完成后需要先执行单元测试生成接口片段，再运行asciidoctor文档构建任务，避免出现找不到片段的错误。

内容的提问来源于stack exchange，提问作者Harold L. Brown