提交 09ca68bf 编写于 作者: cxt104926's avatar cxt104926

导出离线swagger文档

上级 05e96ec4
......@@ -165,13 +165,14 @@
<configuration>
<!--此处端口一定要是当前项目启动所用的端口-->
<swaggerInput>http://127.0.0.1:2020/v2/api-docs</swaggerInput>
<outputDir>src/docs/asciidoc/generated</outputDir>
<outputDir>/src/main/resources/docs</outputDir>
<config>
<!-- 除了ASCIIDOC之外,还有MARKDOWN和CONFLUENCE_MARKUP可选 -->
<swagger2markup.markupLanguage>ASCIIDOC</swagger2markup.markupLanguage>
</config>
</configuration>
</plugin>
<!--此插件生成HTML和PDF-->
<plugin>
<groupId>org.asciidoctor</groupId>
......@@ -190,12 +191,18 @@
<version>1.7.21</version>
</dependency>
</dependencies>
<!-- Configure generic document generation settings -->
<!-- asciildoc 文件目录-->
<configuration>
<sourceDirectory>src/docs/asciidoc/generated</sourceDirectory>
<sourceDirectory>/src/main/resources/docs</sourceDirectory>
<!--生成HTML的目录-->
<!-- <outputDirectory>/src/main/resources/html</outputDirectory>-->
<!-- <backend>html</backend>-->
<sourceHighlighter>coderay</sourceHighlighter>
<attributes>
<!--导航栏在左侧-->
<toc>left</toc>
<!--自动打数字序号-->
<sectnums>true</sectnums>
</attributes>
</configuration>
<!-- Since each execution can only handle one backend, run
......@@ -209,7 +216,7 @@
</goals>
<configuration>
<backend>html5</backend>
<outputDirectory>src/docs/asciidoc/html</outputDirectory>
<outputDirectory>/src/main/resources/html</outputDirectory>
</configuration>
</execution>
<execution>
......@@ -220,13 +227,11 @@
</goals>
<configuration>
<backend>pdf</backend>
<outputDirectory>src/docs/asciidoc/pdf</outputDirectory>
<outputDirectory>/src/main/resources/html</outputDirectory>
</configuration>
</execution>
</executions>
</plugin>
</plugins>
</build>
......
package com.stu.stusystem;
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.jupiter.api.extension.ExtendWith;
import org.junit.runner.RunWith;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.test.context.junit.jupiter.SpringExtension;
import org.springframework.test.context.junit4.SpringRunner;
import java.net.URL;
......@@ -16,18 +20,22 @@ import java.nio.file.Paths;
* @author: cxt
* @time: 2021/2/3
*/
@RunWith(SpringRunner.class)
@SpringBootTest
@ExtendWith(SpringExtension.class)
//@RunWith(SpringRunner.class) // Junit4 开发者使用这个注解
@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.DEFINED_PORT)
public class ImportSwagger {
@Test
public void generateAsciiDocs() throws Exception {
// 输出Ascii格式
Swagger2MarkupConfig config = new Swagger2MarkupConfigBuilder()
.withMarkupLanguage(MarkupLanguage.ASCIIDOC)
.withMarkupLanguage(MarkupLanguage.MARKDOWN) // 设置生成格式Markdown
.withOutputLanguage(Language.ZH) // 设置语言中文
.withPathsGroupedBy(GroupBy.TAGS)
.withGeneratedExamples()
.withoutInlineSchema()
.build();
Swagger2MarkupConverter.from(new URL("http://127.0.0.1:12306/v2/api-docs"))
Swagger2MarkupConverter.from(new URL("http://127.0.0.1:2020/v2/api-docs"))
.withConfig(config)
.build()
.toFolder(Paths.get("src/docs/asciidoc/generated"));
.toFile(Paths.get("/src/main/resources/docs"));
}
}
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册