Swagger号称是最好的Rest Api 文件生成工具,但是作为一个一直从事java相关开发工作的开发者。在2018年6月以前一直坚持用Markdown来手写接口文档,即便是那时候有同事给我推荐过,但作为一个骨子里追求极简的程序员,我一直没有想明白一个需要写一大堆注解强侵入到后端代码工具,它为什么会在中国如此风靡,被很多的java后端应用开发者集成到自己的中。在国内的百度上搜索Swagger相关的博客数量惊人。
在2018年春节我自己萌生了自己一个java rest api文档生成的工具,目的也不是去造轮子,因为我天生不喜欢闲的没事到处造轮子,而起国内已经有一些开源的Java Rest Api文档生成工具,这些工具实现机制几乎和Swagger差不多。只是可能使用更便捷了一些,针对这些工具我没完全没有去使用的意愿。因此开发这个工具的目标非常明确,就是完全不用任何注解,能够去依赖源代码和注释直接分析出文档。围绕着这个目标思考了大半月然后才启动开发,平时也要工作,大概前后经历了两个月后开发出来,经过一段时间的测试和给一些公司试用,在2018年8月成功被开源中国收录,这款工具叫做smart-doc。这个名字也意味着它比其它工具都更加智能。而且目前smart-doc已经被很多公司作为文档生成方案。
smart-doc是一个java restful api文档生成工具,smart-doc颠覆了传统类似swagger这种大量采用注解侵入来生成文档的实现方法。
smart-doc完全基于接口源码分析来生成接口文档,完全做到零注解侵入,你只需要按照java标准注释的写,smart-doc就能帮你生成一个简易明了的markdown
或是一个像GitBook样式的静态html文档。如果你已经厌倦了swagger等文档工具的无数注解和强侵入污染,那请拥抱smart-doc吧!
smart-doc使用和测试可参考smart-doc demo。
# git clone https://github.com/shalousun/api-doc-test.git
原创声明:本文系作者授权腾讯云开发者社区发表,未经许可,不得转载。
如有侵权,请联系 cloudcommunity@tencent.com 删除。
原创声明:本文系作者授权腾讯云开发者社区发表,未经许可,不得转载。
如有侵权,请联系 cloudcommunity@tencent.com 删除。