JFinal中集成JDoc

2019独角兽企业重金招聘Python工程师标准>>>

JDoc是一个用JAVA语言开发的接口文档生成器，利用极简配置就可实现接口文档的生成，避免开发人员花时间去维护接口文档，导致更新不及时，维护困难问题，目前支持JFinal，SpingMVC,SpringBoot框架，格式支持html文档格式 。里面有以上的demo,传送门：http://git.oschina.net/lianghao2016/JDoc

自己公司用的postman接口工具，这个也就玩着耍耍，不过界面看起来还不错，所以记录下自己操作过程。由于JDoc作者还没上传Maven中央库，所以自己还得把项目clone下来自己执行下mvn package，扔上私服（不扔也可以,自己配下，不过应该要加其他依赖）。参考：http://www.jfinal.com/share/262

		<dependency>
		  <groupId>com.nmtx</groupId>
		  <artifactId>jdoc</artifactId>
		  <version>1.1</version>
		</dependency>

 

还有个配置文件，

#指定java文件路径
java.source=src/main/java
#指定需要生成文档的包路径
package.name=com.sandu.edison
#指定采用的框架类型,目前支持jfinal,springmvc两种框架
parser.name=jfinal
#指定文档输出路径
out.path=src/main/webapp/api.html
#指定模版生成器，目前仅支持html
parser.formater=html
#接口访问路径
analysis.prefix.url=http://localhost:8080
#接口前缀
api.prefix=/api

接着new个main方法执行下就可以了。

 public static void main(String[] args) {
    	
        new JFinalApiDocConfig("jdoc.properties").setClearSuffix("Controller").start();
    
    }

可以看到/webapp下面有个api.html，打开一看如下

注意到接口路径里面默认了取DeviceManegeController的前缀DeviceManege小写做路由，不知道有作者有没有提供参数设置。

最后希望JDoc一直发展下去，哈哈哈。

转载于:https://my.oschina.net/xiaoxustudent/blog/878161