Welcome to the api-doc wiki!

smartlion 发布于2019-08-16 18:00 / 879人阅读

摘要：初衷原因很简单，最主要是简化接口文档的编写对接口的修改更加快速的可见主要作用主要功能是生成文档它拓展了标准注释，无需使用注解，减少了入侵。使用类加载主要是为了，更加准确对源码进行解析利用反射。更多持久化方案，如等支持

初衷

原因很简单，最主要是

简化接口文档的编写

对接口的修改更加快速的可见

主要作用

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

海外云主机服务器托管 welcome the sdp for the webrtc Wiki

文章版权归作者所有，未经允许请勿转载,若此文章存在违规行为，您可以联系管理员删除。

转载请注明本文地址：https://www.ucloud.cn/yun/74884.html

浅谈Http模块，Express和Koa实现http服务

摘要：每个中间件可以从实例，接收三个参数，依次为对象代表请求对象代表回应，回调函数代表下一个中间件。等方法除了在回调函数内部判断请求的网址，方法也允许将请求网址写在第一个参数。前言利用node直接实现服务器是运用http模块，Express和Koa都是在其上做的封装，这篇wiki只是想直观的看看封装前后基本使用上的不同，先不去考虑深入的东西。一、http模块 1.1 处理get请求 v...

CoorChice 2019-08-20 16:06 评论0 收藏0
PHP&Nginx&Mysql on Mac

Install Port https://guide.macports.org/ Path You can also add the following line to your ~/.bash_profile: export PATH=/opt/local/bin:$PATH // use the port command first , dont use system command then...

Genng 2019-07-25 13:34 评论0 收藏0
PHP&Nginx&Mysql on Mac

Install Port https://guide.macports.org/ Path You can also add the following line to your ~/.bash_profile: export PATH=/opt/local/bin:$PATH // use the port command first , dont use system command then...

MSchumi 2019-06-27 11:29 评论0 收藏0
【译】CodeIgniter HMVC模块扩展使用文档

摘要：和模块分离类似，模块扩展使得模块变得可便携的。模块化意味着模块化。但是，模块扩展更进一步，它允许这些模块互相通信。 CodeIgniter HMVC扩展说明原文地址：Modular Extensions - HMVC 模块扩展——HMVC 模块扩展让CodeIgniter框架模块化。模块是一组独立的组件（通常有模型、控制器和视图），它们被分类在应用模块的子文件夹中，并且能够直接拖到其...

teren 2019-06-27 11:47 评论0 收藏0
Python2.x 字符编码终极指南

摘要：值得注意的是，有的编码方案不一定能表示某些信息，这时编码就会失败，比如就不能用来表示中文。数组的每一项是一个字节，用来表示。所以对于字符串来说，其长度等于编码后字节的长度。所以，让来编码解码中文，就超出了其能力范围。在人机交互之字符编码一文中对字符编码进行了详细的讨论，并通过一些简单的小程序验证了我们对于字符编码的认识。但仅了解这篇文章的内容，并不能帮我们在日常编程中躲过一些字符编...

Amio 2019-07-25 11:15 评论0 收藏0