Welcome to the api-doc wiki!

Welcome to the api-doc wiki!

初衷

缘由很简单，最主要是

• 简化接口文档的编写
• 对接口的修改更加快速的可见

主要做用

api-doc 主要功能是生成 java api 文档, 它拓展了JavaDoc 标准注释，无需使用注解，减小了入侵。同时，能够规范你的java 文档规范.

原理

首先感谢，javaparser，本项目采用javaparser 进行 java源码扫描，同时，对其源码进行简单拓展使其支持了自定义的javaDocTag,简化开发，修改版的javaparser详见这里。

其次，除了使用源码扫描工具以外，为了对项目代码的入侵，还自定义了一个简单的类加载器，用户只需自定义web项目路径以及预输出路径便可启动。
使用类加载主要是为了，更加准确对源码进行解析(利用反射)。

使用文档

• Get Start
• Java Doc Tag
• JavaParser

demo

demo

TODO LIST

因为是端午节这三天写出来的草图，不少功能还不够完善，我这里有一些已知的问题:

• [ ] @ResponseBody 的支持，
• [ ] Set,List等集合的支持
• [ ] 热加载问题(目前每须要全面进行扫描，存在很大的浪费)
• [ ] 自动加载的问题，这个其实与热加载同样，与git集成
• [ ] Mock，先后端mock 数据，
• [ ] 修改问题，解析出来的东西也只是草图，也须要进行调整。
• [ ] 更多持久化方案，如markdown,json,mongodb 等支持

Reference

dependencies:

• javaParser
• yapi
• git hook
• java doc