swagger生成pdf文档

分手后的思念是犯贱 2022-10-17 05:26 281阅读 0赞

<dependencies>  
        <dependency>  
            <groupId>io.github.swagger2markup</groupId>  
            <artifactId>swagger2markup</artifactId>  
            <version>1.3.1</version>  
        </dependency>  
        <dependency>  
            <groupId>io.springfox</groupId>  
            <artifactId>springfox-staticdocs</artifactId>  
            <version>2.6.1</version>  
        </dependency>  
        <dependency>  
            <groupId>junit</groupId>  
            <artifactId>junit</artifactId>  
        </dependency>  
    </dependencies>

<build>  
        <plugins>  
            <plugin>  
                <groupId>io.github.swagger2markup</groupId>  
                <artifactId>swagger2markup-maven-plugin</artifactId>  
                <version>1.2.0</version>  
                <configuration>  
                      
                    <swaggerInput>http://localhost:8080/v2/api-docs?group=api</swaggerInput>  
                    <outputDir>src/docs/asciidoc/generated/all</outputDir>  
                    <config>  
                          
                        <swagger2markup.markupLanguage>ASCIIDOC</swagger2markup.markupLanguage>  
                    </config>  
                </configuration>  
            </plugin>

<plugin>  
                <groupId>org.asciidoctor</groupId>  
                <artifactId>asciidoctor-maven-plugin</artifactId>  
                <version>1.5.3</version>  
                  
                <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>  
                  
                <configuration>  
                    <sourceDirectory>src/docs/asciidoc/generated/all</sourceDirectory>  
                    <sourceHighlighter>coderay</sourceHighlighter>  
                    <attributes>  
                        <toc>left</toc>  
                    </attributes>  
                </configuration>  
                  
                <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>  
          
        </plugins>  
    </build>

第一步：创建类，并执行

import io.github.swagger2markup.GroupBy;
    import io.github.swagger2markup.Language;
    import io.github.swagger2markup.Swagger2MarkupConfig;
    import io.github.swagger2markup.Swagger2MarkupConverter;
    import io.github.swagger2markup.builder.Swagger2MarkupConfigBuilder;
    import io.github.swagger2markup.markup.builder.MarkupLanguage;
    import org.junit.Test;
    
    import java.net.URL;
    import java.nio.file.Paths;
    
    public class ExportConfig {
        @Test
        public void generateAsciiDocs() throws Exception {
            //    输出Ascii格式
            Swagger2MarkupConfig config = new Swagger2MarkupConfigBuilder()
                    .withMarkupLanguage(MarkupLanguage.ASCIIDOC)
                    .withOutputLanguage(Language.ZH)
                    .withPathsGroupedBy(GroupBy.TAGS)
                    .withGeneratedExamples()
                    .withoutInlineSchema()
                    .build();
            //此处地址务必改为本机地址
            Swagger2MarkupConverter.from(new URL("http://localhost:8080/v2/api-docs"))
                    .withConfig(config)
                    .build()
                    .toFolder(Paths.get("src/docs/asciidoc/generated/all"));
        }
    }

第二步：执行idea-->maven-->compile

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2N3YjUyMXpn_size_16_color_FFFFFF_t_70][]

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2N3YjUyMXpn_size_16_color_FFFFFF_t_70 1][]

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2N3YjUyMXpn_size_16_color_FFFFFF_t_70]: /images/20221014/01dc6a12cfea4534a258b0c3ffbf72ae.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2N3YjUyMXpn_size_16_color_FFFFFF_t_70 1]: /images/20221014/d0502d9cdcab40389567cbc048fe630b.png