spring-restdocs 1.1.0.BUILD-SNAPSHOT maven没有生成adoc文件

时间:2016-03-04 08:45:32

标签: spring-restdocs

我按照 spring-restdocs 1.1.0.BUILD-SNAPSHOT 的testng样本。我可以通过gradle生成adoc文件。但是当我使用maven时它没有生成doc文件。

Mmy pom.xml 具有以下详细信息:

<dependency> 
    <groupId>org.springframework.restdocs</groupId>
    <artifactId>spring-restdocs-mockmvc</artifactId>
    <version>1.1.0.BUILD-SNAPSHOT</version>
    <scope>test</scope>
</dependency>
<plugin> 
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-surefire-plugin</artifactId>
    <configuration>
        <includes>
            <include>**/*TestNgApplicationTests.java</include>
        </includes>
    </configuration>
</plugin>
<plugin> 
    <groupId>org.asciidoctor</groupId>
    <artifactId>asciidoctor-maven-plugin</artifactId>
    <version>1.5.2.1</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>${snippetsDirectory}</snippets> 
                </attributes>
            </configuration>
        </execution>
    </executions>
</plugin>
<plugin>
    <artifactId>maven-resources-plugin</artifactId>
    <executions>
        <execution>
            <id>copy-resources</id>
            <phase>prepare-package</phase>
            <goals>
                <goal>copy-resources</goal>
            </goals>
            <configuration>
                <outputDirectory>${project.build.directory}/classes/static/docs</outputDirectory>
                <resources>
                    <resource>
                        <directory>${project.build.directory}/generated-docs</directory>
                    </resource>
                </resources>
            </configuration>
        </execution>
    </executions>
</plugin>

1 个答案:

答案 0 :(得分:2)

尝试从终端使用此命令运行:

$> mvn package
  • 生成的文件应位于/target下。
    • 生成的代码段应位于/target/generated-snippets
    • 生成的 .html 应位于/target/generated-docs

确保将您的generated-snippets目录配置为测试类的 / target 目录:

@Rule
public RestDocumentation restDocumentation = 
    new RestDocumentation("target/generated-snippets");