Question

我成功使用Spring RestDocs编写测试并生成片段。

当我使用Asciidoctor Maven plugin以HTML格式发布API文档时，会生成HTML文档。

但是，HTML显示以下错误。看来我的include没有按预期运行。我想知道可能出现什么问题。

api-guide.adoc中未解决的指令 - 包括:: /选择/ caweb / ThoughtWorks的/去剂/管道/ xxx_Build / XXX-源/目标/生成-片段/创建-分组/卷曲request.adoc []

以下是 POM.xml 的asciidoctor-maven-plugin和maven-resources-plugin部分：

<plugin> 
            <groupId>org.asciidoctor</groupId>
            <artifactId>asciidoctor-maven-plugin</artifactId>
            <version>1.5.2</version>
            <executions>
                <execution>
                    <id>generate-docs</id>

                    <phase>prepare-package</phase> 
                    <goals>
                        <goal>process-asciidoc</goal>
                    </goals>
                    <configuration>
                        <backend>html</backend>
                        <doctype>book</doctype>
                        <attributes>
                            <snippets>${project.build.directory}/generated-snippets</snippets>
                        </attributes>
                    </configuration>
                </execution>
            </executions>
        </plugin>

        <plugin>
            <artifactId>maven-resources-plugin</artifactId>
            <version>2.7</version>
            <executions>
                <execution>
                    <id>copy-resources</id>
                    <phase>prepare-package</phase>
                    <goals>
                        <goal>copy-resources</goal>
                    </goals>
                    <configuration>
                        <outputDirectory>${project.build.outputDirectory}/static/docs</outputDirectory>
                        <resources>
                            <resource>
                                <directory>${project.build.directory}/generated-docs</directory>
                            </resource>
                        </resources>
                    </configuration>
                </execution>
            </executions>
        </plugin>

以下是我的api-guide.adoc的包含部分：

include::{snippets}/create-grouping/curl-request.adoc[]

感谢您的帮助！

Answer 1

您是否正在配置确定的插件以包含文档文件？

https://github.com/spring-projects/spring-restdocs/blob/master/docs/src/docs/asciidoc/getting-started.adoc

Check here

Answer 2

我通过将asciidoctor的阶段从 prepare-package 更改为 package

来解决这个问题

使用Asciidoctor Maven插件以HTML格式发布API文档时出现未解决的指令错误

2 个答案: