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

相關文章
相關標籤/搜索