技術標籤：小知識點Javaswagger2md文件swagger轉md文件Java

目錄

• 依賴引入
• Java實現

依賴引入

 <!--將swagger轉成md文件start-->

        <dependency>
            <groupId>io.github.swagger2markup</groupId>
            <artifactId>swagger2markup</artifactId>
            <version>1.3.1</version
 
>
        </dependency>
        <dependency>
            <groupId>io.swagger</groupId>
            <artifactId>swagger-models</artifactId>
            <version>1.5.16</version>
        </dependency>
        <dependency>
            <groupId
 
>io.swagger</groupId>
            <artifactId>swagger-core</artifactId>
            <version>1.6.1</version>
        </dependency>
        <!--將swagger轉成md文件end-->

Java實現

url為專案swagger文件的訪問路徑
toFile的路徑是文件下載路徑

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.MalformedURLException;
import java.net.URL;
import java.nio.file.Paths;


/**
 * @Description 自動將swagger生成md文件，直接執行test即可
 * @Date 11:47 2020/12/29
 **/
@RunWith(SpringRunner.class)
@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.DEFINED_PORT)
public class MdDocTest {

    @Test
    public void get() throws MalformedURLException {

        //    輸出md格式
        Swagger2MarkupConfig config = new Swagger2MarkupConfigBuilder()
                .withMarkupLanguage(MarkupLanguage.MARKDOWN) //設定生成格式
                .withOutputLanguage(Language.ZH)  //設定語言中文還是其他語言
                .withPathsGroupedBy(GroupBy.TAGS)
                .withGeneratedExamples()
                .withoutInlineSchema()
                .build();

        Swagger2MarkupConverter.from(new URL("http://localhost:80/demo/api-docs"))
                .withConfig(config)
                .build()
                .toFile(Paths.get("src/main/resources/docs/idmDoc"));
    }

}

就 先 說 到 這 \color{#008B8B}{ 就先說到這} 就先說到這
在 下 A p o l l o \color{#008B8B}{在下Apollo} 在下Apollo
一 個 愛 分 享 J a v a 、 生 活 的 小 人 物 ， \color{#008B8B}{一個愛分享Java、生活的小人物，} 一個愛分享Java、生活的小人物，
咱 們 來 日 方 長 ， 有 緣 江 湖 再 見 ， 告 辭 ！ \color{#008B8B}{咱們來日方長，有緣江湖再見，告辭！} 咱們來日方長，有緣江湖再見，告辭！