swagger 扫描java文档_推荐一款在运行时通过javadoc生成Swagger API文档的库

介绍

一般，我们使用Springfox生成swagger api文档，但Springfox不支持从javadoc中生成，只能通过注解的方式标注文档。

这样，当共享一些POJO类时，为了同时生成javadoc文档和swagger文档，需要重复写两份。

此外，当使用swagger注解时，一般如下使用：

@ApiParam(name="parameterA",value="参数A")

public void path(@PathVariable String parameterA, String parameterB)

其中，name指定了参数的名字，这种通过字符串的方式没有IDE的重构支持。

而通过javadoc指定的方式有IDE的重构支持，当重命名变量名时，会一起修改javadoc中的变量名。

如：

/**

* path 变量

* @param parameterA 参数A

* @param parameterB 参数B

*/

@PostMapping("/path/{parameterA}/{parameterB}")

public void path(@PathVariable String parameterA, String parameterB)

{

}

通过使用RestDoc库，代码如下：

/**

* body 里的复杂对象

*/

@PostMa