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

Question

我配置了一个custom snippet directory with RestDocumentationExtension。

如何为 spring-restdocs-asciidoctor 指定此代码段目录？

Answer 1

您可以在 .adoc 文档的顶部设置 snippets 属性，例如：

:snippets: /your/custom/location

这将覆盖 spring-restdocs-asciidoctor 配置的默认位置。

Answer 2

我在 asciidoctor-maven-plugin 配置的 attributes 标签内使用 snippets 标签配置了我的自定义代码段位置。

<build>
    <plugins>
        <plugin>
            <groupId>org.asciidoctor</groupId>
            <artifactId>asciidoctor-maven-plugin</artifactId>
            <executions>
                <execution>
                    <id>generate-docs</id>
                    <phase>prepare-package</phase>
                    <goals>
                        <goal>process-asciidoc</goal>
                    </goals>
                    <configuration>
                        // other config
                        <attributes>
                            <snippets>${project.basedir}/src/docs/snippets</snippets>
                        </attributes>
                    </configuration>
                </execution>
            </executions>
            <dependencies>
                <dependency>
                    <groupId>org.springframework.restdocs</groupId>
                    <artifactId>spring-restdocs-asciidoctor</artifactId>
                </dependency>
            </dependencies>
        </plugin>
    </plugins>
</build>