提示

这里特别鸣谢开源框架JapiDoc (opens new window)的作者及所有参与开发者. 本框架部分代码借鉴或直接复用JApiDoc (opens new window),在此特别声明.

背景 感谢JapiDoc开辟了通过注释生成接口文档的先河,那么既生亮何生瑜?JAPIDOC是我在多年前接触的一款接口文档生成框架,其优秀的设计理念给我留下了深刻的印象,但遗憾的是该项目已经停止维护了. "先帝创业未半而中道崩殂",老汉作为大汉的重臣,世代食汉禄,怎能甘心蜀汉事业就此陨落?先开辟Easy-Es基(坤)业,现继承先帝遗志,继续创业,造福一众百姓,创业初期,老汉发先先帝遗留了多坏味道, 十分影响使用体验,包括但不限于以下方面:

• 当项目中使用了PageHelper分页插件,则涉及分页接口无法正常生成接口文档
• 当项目中使用了easy-es分页,则涉及分页接口无法正常生成接口文档
• 无法支撑返回模型被打包进jar的情况
• fastjson版本老旧,存在CVE漏洞
• javaparser版本过低,存在CVE漏洞
• 并非完全零侵入,仍需要写一些代码才能生成
• 功能缺失,无法像swagger一样在线调试接口
• jdk版本支持太少,最高仅支持到jdk8
• freemarker生成接口文档时,部分接口参数缺失导致整个生成异常终止问题
• 接口参数中使用wildcard通配符时,类型强转异常导致整个生成异常终止问题
• interface类型的接口无法被读取问题
• 解决DDD扫描器无法识别未加@RestController/@Controller的场景
• 生成文档结构混乱,接口较多时不能快速找到首页及Markdown等文档
• 不支持水印,密级,跨域等高频功能
• UI和交互设计较为简单,不够优雅
• 源码未上传至maven中央仓库,使用时如需看源码还无法通过编辑器自动下载,接口相关参数也无法在编辑器中提示
• 源码中很多注释缺失
• 使用不够傻瓜级
• 官网文档不够全面易懂等
• ...

上面提到的前面几项已经足够致命,致使在大多数项目中无法正常使用,当然还有一个最大的问题是开源社区停止维护了,以上所有问题都得不到解决和修复,几乎无法真正投入使用,这对开源项目来说是致命的.

幸运的是,上述问题在doc-apis中全部都得到了解决,并且我们并不满足于此,将长期迭代和提供社区支持,我们的目标是做到此领域全球NO.1,没开玩笑!

熟悉Easy-Es的小伙伴应该知道我在社区叫老汉,真实名字的首字母缩写是xpc,请大胆用您的输入法敲出这三个字母,首先映入眼帘的便是"想屁吃",没错! 实际上我就是这样一个人,曾幻想能够一行代码也不用写,一行配置也不用加,

接口定义好了就直接能和前端进入联调状态,时至今日,为了让梦想照进现实,我决定开源doc-apis并长期维护,上述提到的所有已发现问题已经在doc-apis中全部修复,并且新增了更多易用的功能,也规划了很多更"想屁吃"的特性,例如不仅可以自动生成文档,还可以

在自动生成的文档上一键调试接口,什么swagger(丝袜哥)来了都得把丝袜脱了俯首称臣, 那么到底是老汉在"想屁吃"还是真有两把刷子? "浇给"时间来验证,再来点cua(欢迎加入我们)!

最后,也希望所有人都能大胆"想屁吃",如果连幻想的勇气都没有,又如何实现癞蛤蟆想吃天鹅肉的梦想? 从easy-es到doc-apis,我一直都在"想屁吃",健身亦是如此,时至今日已健身10年,曾经幻想的身材也已照进现实,最后得出一句,人生需要很多的"想屁吃",与君共勉!