前言
写代码的高兴,在于通过一顿猛如虎的操作,实现了本人设计的逻辑流程。(也可能并不是很高兴!)
这时候,你认为就能够关机么?
还有接口文档没写呢!
哈?
开始进入有限 CV 模式,各种申请参数、必填非必填、申请返回示例!
几分钟后…… 🤬🤬🤬
我要写个 IDEA 插件,当前再也不想手写文档了!
上面,来看看我肝进去的插件吧!
性能介绍
插件名字必须得先介绍,Doc View
,有趣味的小伙伴间接在 IDEA 中搜寻插件即可。
- Controller/Dubbo 接口文档生成
- 反对 Validation、Swagger 等注解
- Markdown 接口查看、预览、复制、导出
- 反对自定义生成接口的 Markdown 模版
- 反对界面编辑文档、正文、并同步保留到代码正文中
- 反对在编辑实体界面, 将实体复制为 Json 字符串
- 反对上传文档到 YApi
- 反对自定义配置
性能就不留悬疑了,间接介绍进去,上面用再用图文介绍下,毕竟水灵灵的说文字介绍,也太么得感情了!
主界面
生成 Markdown
生成 Markdown 文档蕴含:接口名称、接口形容、申请门路、申请形式、申请参数、申请示例、返回参数、返回示例。
这些全都是依据办法的正文、注解、出参、入参解析进去的
小伙伴想看源码或者提交 PR,文末有 github 地址。
为什么生成 Markdown?
因为格局比拟难看,并且很容易转换为 Html、PDF、Word 等格局。
间接将 Markdown 文本复制到 VS Code,预览图如下:
- 自定义 Markdown
这里也是反对肯定水平上自定义 Markdown 的格局的。
能够在 IDEA 设置选项中,找到 Doc View 的相干设置,进行自定义 Markdown 的款式。
- 字段正文设置
这里反对 Swagger3、Swagger、正文 tag 的形式设置相干信息。
面板性能
- 预览
左下角间接应用 IDEA 内置 Markdown 面板进行预览文件。
IDEA 2020.2 以上版本才能够哦!
- 导出
在面板左右两边,别离有两个导出按钮,对应着批量导出和导出以后。
- 复制
间接将 Markdown 文本复制到剪贴板。不过也能够间接在文本域中应用 ⌘ + A
全选后复制。
也能够 ⌘ + F
唤出搜寻框,不过个别很少应用。
上传 YApi
如果说生成 Markdown 文本,是为了不便复制到 ShowDoc 之类反对 Markdown 的 API 文档网站,那 Api 呢?
这里也是反对的!
间接通过上传按钮,能够一键上传到 YApi。
不过记得设置地址和 Token。
文档编辑
外围性能除了生成 Markdown、预览、上传 YApi 之外,这个性能相对来说还不是很欠缺。
那就是编辑文档及字段。
Doc Editor 能够在办法、实体类中应用,并生成相应的正文。
并且能够将实体类复制为 Json。
这个性能和 Toolkit 相似。
总结
整体性能就这些了,根本能够满足大部分文档需要。其余的就是边边角的修修改改。
来来来,小伙伴们一起用起来,帮忙踩踩坑,提提倡议。
我的项目 & 反馈地址:https://github.com/liuzhihang…
连忙下载去吧!