4

我成功地使用 Spring RestDocs 编写了一个测试并生成了代码片段。

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

但是,HTML 显示以下错误。似乎我的包含没有按预期运行。我想知道有什么问题。

api-guide.adoc 中未解决的指令 - 包括::/opt/caweb/thoughtworks/go-agent/pipelines/xxx_Build/xxx-source/target/generated-snippets/creating-grouping/curl-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[]

谢谢您的帮助!

4

2 回答 2

0

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

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

在这里检查

于 2016-02-08T12:33:44.050 回答
0

我通过将 asciidoctor 的阶段从prepare-package更改为package来解决它

于 2016-06-24T11:44:25.440 回答