Swagger转Markdown输出
/*
* @author chengm
* @Description:
* @date 2021/9/9 10:30
* @Email:2554550408@qq.com
*/
import com.orbita.cloud.sample_data.provider.SampleDataProviderApplication;
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 io.swagger.v3.oas.models.OpenAPI;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.boot.test.autoconfigure.web.servlet.AutoConfigureMockMvc;
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)
@AutoConfigureMockMvc
@SpringBootTest(classes = SampleDataProviderApplication.class)
public class swaggerMdTest {
@Test
public void generateAsciiDocs() throws Exception {
// 输出Ascii格式
// Swagger2MarkupConfig config = new Swagger2MarkupConfigBuilder()
// .withMarkupLanguage(MarkupLanguage.ASCIIDOC)
// .build();
//
// Swagger2MarkupConverter.from(new URL("http://localhost:8080/v2/api-docs"))
// .withConfig(config)
// .build()
// .toFolder(Paths.get("src/docs/asciidoc/generated"));
// 输出Ascii格式
Swagger2MarkupConfig config = new Swagger2MarkupConfigBuilder()
.withMarkupLanguage(MarkupLanguage.ASCIIDOC)
.withOutputLanguage(Language.ZH)
.withPathsGroupedBy(GroupBy.TAGS)
.withGeneratedExamples()
.withoutInlineSchema()
.build();
Swagger2MarkupConverter.from(new URL("http://localhost:8766/v3/api-docs"))
.withConfig(config)
.build()
.toFolder(Paths.get("./docs/asciidoc/generated"));
输出Markdown格式
// Swagger2MarkupConfig config = new Swagger2MarkupConfigBuilder()
// .withMarkupLanguage(MarkupLanguage.MARKDOWN)
// .withOutputLanguage(Language.ZH)
// .withPathsGroupedBy(GroupBy.TAGS)
// .withGeneratedExamples()
// .withoutInlineSchema()
// .build();
//
// Swagger2MarkupConverter.from(new URL("http://192.168.1.200:8766/v3/api-docs"))
// .withConfig(config)
// .build()
// .toFolder(Paths.get("./docs/markdown/generated"));
}
}