swagger2markup官方参考文档地址:
http://swagger2markup.github.io/swagger2markup/1.3.3/
本次主要基于插件生成,第一步通过插件swagger2markup读取swager中得url,获得adoc文件,第二步使用asciidoctor生成html
需要特殊注意得是: 如果 swagger2markup不配置outputFile那么会生成4个adoc,最后转换html也会得到四个html.笔者这里为了后续阅读方便,需要生成一个html文件即可.
本次pom完整配置如下:
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>org.example</groupId>
<artifactId>swaggerToHtml</artifactId>
<version>1.0-SNAPSHOT</version>
<description>本项目主要用于利用maven插件将swagger转换为html</description>
<properties>
<maven.compiler.source>8</maven.compiler.source>
<maven.compiler.target>8</maven.compiler.target>
</properties>
<dependencies>
<dependency>
<groupId>io.github.swagger2markup</groupId>
<artifactId>swagger2markup</artifactId>
<version>1.3.3</version>
</dependency>
</dependencies>
<build>
<plugins>
<!--生成给ascall文档-->
<plugin>
<groupId>io.github.swagger2markup</groupId>
<artifactId>swagger2markup-maven-plugin</artifactId>
<version>1.3.1</version>
<configuration>
<swaggerInput>http://192.168.0.202:29810/standard/v2/api-docs</swaggerInput><!---swagger-api-json路径-->
<outputDir>./docs/asciidoc</outputDir><!---生成路径-->
<outputFile>./docs/asciidoc/index</outputFile><!--此处不指定会生成四个文件-->
<config>
<swagger2markup.markupLanguage>ASCIIDOC</swagger2markup.markupLanguage><!--生成格式-->
<swagger2markup.pathsGroupedBy>TAGS</swagger2markup.pathsGroupedBy>
</config>
</configuration>
</plugin>
<!--依赖于swagger2markup生成的ascall文件结果-->
<plugin>
<groupId>org.asciidoctor</groupId>
<artifactId>asciidoctor-maven-plugin</artifactId>
<version>1.5.6</version>
<configuration>
<sourceDirectory>./docs/asciidoc</sourceDirectory>
<outputDirectory>./docs/asciidoc/html</outputDirectory>
<!--<headerFooter>true</headerFooter>
<doctype>book</doctype>-->
<backend>html</backend>
<sourceHighlighter>coderay</sourceHighlighter>
<attributes>
<!--菜单栏在左边-->
<toc>left</toc>
<!--多标题排列-->
<!--<toclevels>3</toclevels>
<!-自动打数字序号-->
<!--<sectnums>true</sectnums>-->
</attributes>
</configuration>
</plugin>
</plugins>
</build>
</project>
网友评论