从swagger定义生成文档

Since 0.5.2

从0.5.2开始，jmms命令行提供从本地或远程的swagger定义生成gitbook文档的功能。

生成gitbook文档

$ jmms doc gen https://petstore.swagger.io/v2/swagger.json

Reading 'https://petstore.swagger.io/v2/swagger.json'...

   create api-doc/pom.xml

...

Doc generated at '***/api-doc/' successfully!

文档默认在./api-doc目录，可以通过-o参数设置输出目录

$ jmms doc gen https://petstore.swagger.io/v2/swagger.json -o my-doc

把文档生成到./my-doc目录

浏览文档

生成文档后可以通过gitbook工具浏览、编辑文档以及生成html网站。

安装gitbook

$ npm install gitbook-cli -g

详细请看gitbook安装文档。

浏览文档

$ cd api-doc
$ gitbook install
$ gitbook serve

...

Starting server ...
Serving book on http://localhost:4000

浏览器访问http://localhost:4000查看文档。