zoukankan      html  css  js  c++  java
  • Springboot swagger2 导出api文档

    具体导出的代码,参考了:http://www.spring4all.com/article/699

    导出前,首先需要配置好swagger2,参见 https://www.cnblogs.com/yanqin/p/9145895.html

    直接贴代码:

    <dependency>
    			<groupId>io.github.swagger2markup</groupId>
    			<artifactId>swagger2markup</artifactId>
    			<version>1.3.1</version>
    		</dependency>
    		<dependency>
    			<groupId>ch.netzwerg</groupId>
    			<artifactId>paleo-core</artifactId>
    			<version>0.10.2</version>
    		</dependency>
    		<dependency>
    			<groupId>io.vavr</groupId>
    			<artifactId>vavr</artifactId>
    			<version>0.9.2</version>
    		</dependency>
    

      code

    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.boot.test.context.SpringBootTest;
    import org.springframework.test.context.junit4.SpringRunner;
    
    import java.net.URL;
    import java.nio.file.Paths;
    
    
    @RunWith(SpringRunner.class)
    @SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.DEFINED_PORT)
    public class SwaggerTo {
    
    	/**
    	 * 生成AsciiDocs格式文档
    	 * @throws Exception
    	 */
    	@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:8016/v2/api-docs"))
    				.withConfig(config)
    				.build()
    				.toFolder(Paths.get("./docs/asciidoc/generated"));
    	}
    
    	/**
    	 * 生成Markdown格式文档
    	 * @throws Exception
    	 */
    	@Test
    	public void generateMarkdownDocs() 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:8016/v2/api-docs"))
    				.withConfig(config)
    				.build()
    				.toFolder(Paths.get("./docs/markdown/generated"));
    	}
    //	/**
    //	 * 生成Confluence格式文档
    //	 * @throws Exception
    //	 */
    //	@Test
    //	public void generateConfluenceDocs() throws Exception {
    //		//    输出Confluence使用的格式
    //		Swagger2MarkupConfig config = new Swagger2MarkupConfigBuilder()
    //				.withMarkupLanguage(MarkupLanguage.CONFLUENCE_MARKUP)
    //				.withOutputLanguage(Language.ZH)
    //				.withPathsGroupedBy(GroupBy.TAGS)
    //				.withGeneratedExamples()
    //				.withoutInlineSchema()
    //				.build();
    //
    //		Swagger2MarkupConverter.from(new URL("http://localhost:8016/v2/api-docs"))
    //				.withConfig(config)
    //				.build()
    //				.toFolder(Paths.get("./docs/confluence/generated"));
    //	}
    
    	/**
    	 * 生成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:8016/v2/api-docs"))
    				.withConfig(config)
    				.build()
    				.toFile(Paths.get("./docs/asciidoc/generated/all"));
    	}
    
    	/**
    	 * 生成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:8016/v2/api-docs"))
    				.withConfig(config)
    				.build()
    				.toFile(Paths.get("./docs/markdown/generated/all"));
    	}
    }
    

      

  • 相关阅读:
    sql中not exists的用法
    jsp中target="_blank"的用法
    jsp 运用 session 登录输出
    jsp留言板
    编写JSP 实现用户登录并判断用户或密码
    jsp打印九九乘法表
    jsp输出当前时间
    jsp输出金字塔
    jsp输出5的阶乘
    jdbc练习3
  • 原文地址:https://www.cnblogs.com/yanqin/p/9145941.html
Copyright © 2011-2022 走看看