swagger 接口文檔 導出（Markdown）

swagger導出markdown文檔

至於swagger的搭建，這里就不贅述了。

引入依賴

<dependency>
    <groupId>io.github.swagger2markup</groupId>
    <artifactId>swagger2markup</artifactId>
    <version>1.3.3</version>
</dependency>

導出代碼

public static 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:8080/v2/api-docs"))
            .withConfig(config)
            .build()
            .toFile(Paths.get("./docs/markdown/generated/all"));
}

博主使用的是 spring-boot，直接在main方法里調用了。

        try {
            generateMarkdownDocsToFile();
        } catch (Exception e) {
            e.printStackTrace();
        }

swagger 中的配置

swagger配置的時候，需要配置上url

/**
* URL
*/
@Value("${swagger.url}")
private String url;

@Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage(basePackage))
                .paths(PathSelectors.any())
                .build()
                .globalOperationParameters(setHeaderToken());
    }
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title(title)
                .description(description)
                .termsOfServiceUrl(url) // 重點是這里
                .contact(new Contact(contactName,contactUrl,contactEmail))
                .version(version)
                .build();
    }

yml中url的配置

swagger:
  url: '/v2/api-docs'
  # 其他配置....

后續

導出markdown文件后，就可以方便轉word文檔了。
這里給出一個在線網址：markdown在線轉word