swagger导出接口文档

pom依赖

<!--  swagger导出PDF/HTML所需依赖  -->
<dependency>
	<groupId>io.github.swagger2markup</groupId>
	<artifactId>swagger2markup</artifactId>
	<version>1.3.1</version>
</dependency>

pom插件依赖

swagger2markup

			<plugin>
				<groupId>io.github.swagger2markup</groupId>
				<artifactId>swagger2markup-maven-plugin</artifactId>
				<version>1.2.0</version>
				<configuration>
					<!--此处端口一定要是当前项目启动所用的端口-->
					<!--地址如图一-->
					<swaggerInput>http://172.0.0.1:8081/service-server/v2/api-docs?group=platform</swaggerInput>
					<!--生成多个文件-->
					<!--<outputDir>src/docs/asciidoc/generated</outputDir>-->
					<!--生成单个文件-->
					<outputFile>src/docs/asciidoc/api</outputFile>
					<config>
						<!-- 除了ASCIIDOC之外,还有MARKDOWN和CONFLUENCE_MARKUP可选,下面生成HTML和PDF的的插件依赖ASCIIDOC格式 -->
						<swagger2markup.markupLanguage>MARKDOWN</swagger2markup.markupLanguage>
					</config>
				</configuration>
			</plugin>

			<plugin>
				<groupId>org.asciidoctor</groupId>
				<artifactId>asciidoctor-maven-plugin</artifactId>
				<version>1.5.3</version>
				<!-- Include Asciidoctor PDF for pdf generation -->
				<dependencies>
					<dependency>
						<groupId>org.asciidoctor</groupId>
						<artifactId>asciidoctorj-pdf</artifactId>
						<version>1.5.0-alpha.10.1</version>
					</dependency>
					<dependency>
						<groupId>org.jruby</groupId>
						<artifactId>jruby-complete</artifactId>
						<version>1.7.21</version>
					</dependency>
				</dependencies>
				<!-- Configure generic document generation settings -->
				<configuration>
					<!--对应上面插件的outputdir-->
					<!--<sourceDirectory>src/docs/asciidoc/generated</sourceDirectory>-->
					<!--对应上面插件的outputfile-->
					<sourceDirectory>src/docs/asciidoc</sourceDirectory>
					<sourceDocumentName>api.adoc</sourceDocumentName>
					<sourceHighlighter>coderay</sourceHighlighter>
					<attributes>
						<toc>left</toc>
					</attributes>
				</configuration>
				<!-- Since each execution can only handle one backend, run
                     separate executions for each desired output type -->
				<executions>
					<execution>
						<id>output-html</id>
						<phase>generate-resources</phase>
						<goals>
							<goal>process-asciidoc</goal>
						</goals>
						<configuration>
							<backend>html5</backend>
							<outputDirectory>src/docs/asciidoc/html</outputDirectory>
						</configuration>
					</execution>
					<!--pdf中文有乱码,目前不太好用-->
					<execution>
						<id>output-pdf</id>
						<phase>generate-resources</phase>
						<goals>
							<goal>process-asciidoc</goal>
						</goals>
						<configuration>
							<backend>pdf</backend>
							<outputDirectory>src/docs/asciidoc/pdf</outputDirectory>
						</configuration>
					</execution>
				</executions>
			</plugin>

图一

在这里插入图片描述

maven命令

在这里插入图片描述

1.mvn swagger2markup:convertSwagger2markup

2.mvn generate-resources

第一个插件生成adoc文件,也可以选择生成md文件

第二个插件需要依赖第一个插件的adoc文件,PDF中文会有乱码,我是用上一步的md文件导出的PDF,也很方便

还有如果喜欢HTML的文件,第二个插件会生成一个HTML文件,也很方便。

导出失败json有问题

详情见
https://blog.csdn.net/Old_Fat/article/details/120269405

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值