接口文档自动生成工具
如图:
团队协作离不开约定,规范,最早我们用word,excel编写接口文档,现在有了开源,涌现了一批接口文档管理平台, rap , 小幺鸡, apiManager等等, 有了更友好结构化展示,版本历史, mock等等好用功能。
问题来了, 写好了代码怎么维护到api管理平台上,只能手工操作。或者自已定义一套注解库,用来标识请求参数,返回参数,这样对代码的侵入性又有点太强了。
javadoc 这个功能似乎被我们怱略了,连身边朋友都没见有人在用这个。javadoc 提供了很强劲的分析源码的功能,参数类型, 返回类型, 泛型等等,统统可以取到, 请求参数,返回参数出现循环引用问题, 目前限制到4层。
第一个版本对接了rap , 后来在使用过程中,rap越来越慢,最后迁到小幺鸡,原来内部使用shell脚本执行, 这一个版本使用maven 插件的形式,现在还处理初级阶段,有兴趣的朋友可以修改,自己使用。
有兴趣的朋友可以了解一下javadoc的使用方式, 这个工具使用也是建立在javadoc之上,maven插件也是在maven javadoc 插件的基础上。