為 spring-restdocs-asciidoctor 指定自定義片段目錄？

Question

我已經使用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>