需要在pom文件中添加依赖
<!--将swagger测试接口生成的api转成word-->
<dependency>
<groupId>io.github.swagger2markup</groupId>
<artifactId>swagger2markup</artifactId>
<version>1.3.1</version>
</dependency>
<!--将swagger测试接口生成的api转成word-->
<repositories>
<repository>
<snapshots>
<enabled>true</enabled>
<updatePolicy>always</updatePolicy>
</snapshots>
<id>jcenter-releases</id>
<name>jcenter</name>
<url>http://jcenter.bintray.com</url>
</repository>
</repositories>
添加完依赖创建一个测试类
@org.junit.Test
public void generateMarkdownDocsToFile() throws Exception {
// 输出Markdown到单文件
Swagger2MarkupConfig config = new Swagger2MarkupConfigBuilder()
.withMarkupLanguage(MarkupLanguage.MARKDOWN)
.withOutputLanguage(Language.ZH)
.withPathsGroupedBy(GroupBy.TAGS)
.withGeneratedExamples()
.withoutInlineSchema()
.build();
//url是项目的访问路径(就是在swagger测试页面上看到的那个地址)
Swagger2MarkupConverter.from(new URL("http://localhost:8080/v2/api-docs"))
.withConfig(config)
.build()
//生成文件保存路径
.toFile(Paths.get("./docs/markdown/generated/all"));
}
运行测试类之前要把项目起来,启动项目后才可以运行这个测试类
因为生成的是 .md文件,需要转成word格式,推荐个我在用的网站添加链接描述打开all.md文件把里面的内容辅助到网站中并保存为word文档即可(文档需要下载)