文档指南

Added in 0.4

jmms从0.4.0版本开始内置了API文档生成功能，无需编码和额外配置即可自动生成gitbook文档。

生成文档

在pom.xml中添加依赖：

<dependencies>
        <dependency>
            <groupId>org.leapframework</groupId>
            <artifactId>jmms-plugins-swagger-doc</artifactId>
            <version>${jmms.version}</version>
            <optional>true</optional>
        </dependency>
</dependencies>

重新启动jmms工程

$ jmms run

在控制台应该出现Swagger doc generated的日志。

预览文档

文档生成后，在工程目录下的doc目录中将会出现类似下面的结构：

doc
├── SUMMARY.md
├── _layouts
│   └── website
│       └── header.html
├── book.json
├── definitions.md
├── info.md
├── operations.md
├── overview.md
├── security.md
├── styles
│   └── website.css
└── swagger.json

进入doc目录，启动gitbook：

$ cd doc
$ gitbook install
$ gitbook serve
$ Starting server ...
$ Serving book on http://localhost:4000

打开浏览器访问http://localhost:4000，出现类似下图的文档：