swagger 导出 docs

最新推荐文章于 2024-08-15 09:53:54 发布

程序员中最靓的仔

最新推荐文章于 2024-08-15 09:53:54 发布

阅读量409

点赞数

分类专栏：业务设计文章标签： spring java

本文链接：https://blog.csdn.net/weixin_42169336/article/details/123826890

版权

业务设计专栏收录该内容

2 篇文章 0 订阅

订阅专栏

# swagger 2.8.0
<io.swagger.version>1.5.20</io.swagger.version>
<swagger2markup.version>1.3.3</swagger2markup.version>
<!-- swagger生成接口API离线 -->
<dependency>
    <groupId>io.github.swagger2markup</groupId>
    <artifactId>swagger2markup</artifactId>
</dependency>
<dependency>
    <groupId>io.swagger</groupId>
    <artifactId>swagger-core</artifactId>
</dependency>
<dependency>
    <groupId>io.swagger</groupId>
    <artifactId>swagger-models</artifactId>
</dependency>


import com.zkj.wecommarketing.operate.MaterialSofaServerApplication;
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 org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;

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

@RunWith(SpringJUnit4ClassRunner.class)
@SpringBootTest(classes = MaterialSofaServerApplication.class, webEnvironment = SpringBootTest.WebEnvironment.DEFINED_PORT)
public class CreateSwaggerFile {

    @Value("${server.port}")
    private String port;

    @Value("${server.servlet.context-path}")
    private String path;

    /**
     * 生成AsciiDocs格式文档,并汇总成一个文件
     *
     * @throws Exception
     */
    @Test
    public void generateAsciiDocsToFile() 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:" + port + path + "/v2/api-docs"))
                .withConfig(config)
                .build()
                .toFile(Paths.get("./docs/asciidoc/generated/Api-1.0"));
    }
    /**
 * 生成Markdown格式文档,并汇总成一个文件
 *
 * @throws Exception
 */
@Test
public void generateMarkdownDocsToFile() throws Exception {
    //    输出Markdown到单文件
    Swagger2MarkupConfig config = new Swagger2MarkupConfigBuilder()
            .withMarkupLanguage(MarkupLanguage.MARKDOWN)
            .withOutputLanguage(Language.ZH)
            .withPathsGroupedBy(GroupBy.TAGS)
            .withGeneratedExamples()
            .withoutInlineSchema()
            .build();

    Swagger2MarkupConverter.from(new URL("http://localhost:18080/v2/api-docs"))
            .withConfig(config)
            .build()
            .toFile(Paths.get("./docs/markdown/generated/Api-1.0"));
}
    ~~~