用Swagger2markup导出接口文档

前言

最近公司正好需要整理接口文档，就想把Swagger2的文档导出来。

开始配置

pom.xml

    io.github.swagger2markup
    swagger2markup
    1.3.3
    test



    commons-beanutils
    commons-beanutils
    1.9.2
    test

使用单元测试生成文档

package com.asiainfo.aigov;

import java.net.URL;
import java.nio.file.Paths;

import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.test.context.junit4.SpringRunner;

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;

@RunWith(SpringRunner.class)
@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.DEFINED_PORT)
public class Swagger2Test {

    @Test
    public void generateAsciiDocs() throws Exception {
        Swagger2MarkupConfig config = new Swagger2MarkupConfigBuilder()
                .withMarkupLanguage(MarkupLanguage.MARKDOWN)
                .withOutputLanguage(Language.ZH)
                .withPathsGroupedBy(GroupBy.TAGS)
                .withoutInlineSchema()
                .build();
        Swagger2MarkupConverter.from(new URL("http://localhost:8080/familydoctor-webapp/v2/api-docs"))
                .withConfig(config)
                .build()
//                .toFolder(Paths.get("./docs"));
                .toFile(Paths.get("./docs/api"));
    }
    
}

结后语

生成的文档是md格式，可以放到有道云笔记里，再导出为pdf或html，也可以用pandoc转成word。