swagger-ui + swagger2markup-cli + asciidoctor 生成api文档

参考:https://segmentfault.com/a/1190000017873594?utm_source=tag-newesthtml

swagger-ui地址为:http://sample.com:8888/zk/swagger-ui.htmljava

经过https://github.com/Swagger2Markup/swagger2markup-cli clone源码,该工程使用Gradle,用IDEA打开后,View->Tool Windows->Gradle打开Gradle的操做窗口,双击Tasks->build->jar:git

在工程目录/build/libs下生成相应的jar包:github

执行指令(注意swagger-json文件的URL为swagger-ui的<base url>/v2/api-docs):json

java -jar swagger2markup-cli-1.3.3.jar convert -i http://sample.com:8888/zk/v2/api-docs -f zkong

生成文件zkong.adoc,该文件没法被通常的应用程序打开,须要使用asciidoctor转换为html。为了使用asciidoctor,须要在Windows安装ruby,经过https://rubyinstaller.org/downloads/ 下载ruby安装文件,能够选择WITHOUT DEVKIT的版本:segmentfault

默认安装,完成以后打开"Start Command Prompt with Ruby", 安装asciidoctor:api

gem install Asciidoctor

使用asciidoctor转换adoc文件:浏览器

asciidoctor -d book -a toc=left -a sectnums C:\Users\zhusi\code\swagger2markup-cli\build\libs\zkong.adoc

在.adoc文件同目录下会生成.html文件,可用浏览器打开。api文档生成完成。ruby

相关文章
相关标签/搜索