非Java开发者如何将Swagger JSON转为AsciiDoc兼容的Markdown?
把Swagger JSON转成AsciiDoc的简单方法(无需Java开发经验)
别担心,哪怕你完全不懂Java,也能轻松把Swagger JSON转换成AsciiDoc格式。swagger2markup确实是个好工具,但不用非得碰JUnit——我给你推荐两个更友好的方案:
方案一:用swagger2markup命令行工具
这是最直接的方法,不用写代码:
- 先下载swagger2markup的命令行jar包(找最新版本的
swagger2markup-cli-*.jar) - 把你的Swagger JSON文件(比如命名为
swagger.json)和jar包放在同一个文件夹里 - 打开终端/命令行,进入这个文件夹,执行以下命令:
参数说明:java -jar swagger2markup-cli-1.3.3.jar convert -i swagger.json -o output.adoc -f ASCIIDOC-i:指定你的Swagger JSON文件路径-o:指定输出的AsciiDoc文件名-f ASCIIDOC:明确告诉工具要生成AsciiDoc格式(默认也支持Markdown,这里我们指定ASCIIDOC)
执行完之后,你就能得到一个output.adoc文件,直接可以用Asciidoctor工具处理成HTML或PDF。
方案二:用Docker(无需安装Java)
如果你已经装了Docker,这个方法更省心,连Java都不用装:
打开终端执行:
docker run --rm -v $(pwd):/work swagger2markup/swagger2markup convert -i /work/swagger.json -o /work/output.adoc -f ASCIIDOC
这里-v $(pwd):/work是把你当前的目录挂载到容器里,这样容器能读取你的swagger.json,生成的output.adoc也会存在当前目录下。
关于JUnit的方法(不推荐给非Java开发者)
如果一定要用JUnit的方式,本质是写个简单的Java测试类来触发转换,但需要配置Maven/Gradle依赖,还要写几行代码,对不懂Java的人来说有点麻烦,所以优先推荐上面两个方案。
内容的提问来源于stack exchange,提问作者Diana Bishop
相关产品推荐
相关产品推荐

