swagger中导出接口文档

  1. 添加依赖
	<dependency>
     	<groupId>io.github.swagger2markup</groupId>
        <artifactId>swagger2markup</artifactId>
        <version>1.3.1</version>
    </dependency>
  1. build中添加plugin插件
	<plugin>
	    <groupId>io.github.swagger2markup</groupId>
	    <artifactId>swagger2markup-maven-plugin</artifactId>
	    <version>1.2.0</version>
	    <configuration>
	        <!--此处端口一定要是当前项目启动所用的端口-->
	        <swaggerInput>http://localhost:8084/v2/api-docs</swaggerInput>
	        <outputDir>src/docs/asciidoc/generated</outputDir>
	        <config>
	            <!-- 除了ASCIIDOC之外,还有MARKDOWN和CONFLUENCE_MARKUP可选 -->
	            <swagger2markup.markupLanguage>ASCIIDOC</swagger2markup.markupLanguage>
	        </config>
	    </configuration>
   	</plugin>
  1. 继续加生成html和pdf文件的插件,这个时候让依赖下载一会,下载一会
	<plugin>
      <groupId>org.asciidoctor</groupId>
        <artifactId>asciidoctor-maven-plugin</artifactId>
        <version>1.5.3</version>
        <!-- Include Asciidoctor PDF for pdf generation -->
        <dependencies>
            <dependency>
                <groupId>org.asciidoctor</groupId>
                <artifactId>asciidoctorj-pdf</artifactId>
                <version>1.5.0-alpha.10.1</version>
            </dependency>
            <dependency>
                <groupId>org.jruby</groupId>
                <artifactId>jruby-complete</artifactId>
                <version>1.7.21</version>
            </dependency>
        </dependencies>
        <!-- Configure generic document generation settings -->
        <configuration>
            <sourceDirectory>src/docs/asciidoc/generated</sourceDirectory>
            <sourceHighlighter>coderay</sourceHighlighter>
            <attributes>
                <toc>left</toc>
            </attributes>
        </configuration>
        <!-- Since each execution can only handle one backend, run
             separate executions for each desired output type -->
        <executions>
            <execution>
                <id>output-html</id>
                <phase>generate-resources</phase>
                <goals>
                    <goal>process-asciidoc</goal>
                </goals>
                <configuration>
                    <backend>html5</backend>
                    <outputDirectory>src/docs/asciidoc/html</outputDirectory>
                </configuration>
            </execution>

            <execution>
                <id>output-pdf</id>
                <phase>generate-resources</phase>
                <goals>
                    <goal>process-asciidoc</goal>
                </goals>
                <configuration>
                    <backend>pdf</backend>
                    <outputDirectory>src/docs/asciidoc/pdf</outputDirectory>
                </configuration>
            </execution>

        </executions>
   </plugin>
  1. 执行命令
 1.mvn swagger2markup:convertSwagger2markup
 2.mvn generate-resources
  1. 左侧生成文件夹中的paths.html打开就是接口文档的样子,将这个html文件复制成word就可以了
    生成的文件夹

猜你喜欢

转载自blog.csdn.net/weixin_45121502/article/details/106349831