Doc View 是一款快捷生成接口文档 IDEA 插件,应用 Doc View 能够将开发人员从繁琐的文档编写中释放出来,极大的节俭开发工夫。
Doc View 反对以下性能:
- Controller/Dubbo 接口生成 Markdown 文档
- 查看 Markdown 源码,预览 Markdown, 编辑接口字段等
- 反对自定义配置 Markdown 模版
- 导出 Markdown 文件到本地
- 上传到 YApi、ShowDoc、语雀
- 文档目录查看、操作、导出
- 导航栏 Icon 快捷操作
- 生成 Http Client
看着这么多功能,是不是很想下载试一试,能够在 IDEA plugin 搜寻 Doc View
进行装置。
上面简略介绍下几个罕用的性能。
生成文档
能够通过在右键菜单或者点击左侧导航栏的 M
进入展现界面。
界面能够:导出全副、上传全副、预览、查看 MD 源文件、编辑、单文件上传等。
其中上传反对 YApi、ShowDoc、语雀
文档目录
在右侧窗口反对查看以后我的项目的所有接口文档列表,依照 Module、Class 树状排列。
Open:生成 Markdown 源文件
Http Client:生成 Http Client 文件
其中 Markdown 文件能够利用 IDEA 导出 Docs、PDF、HTML,Http Client 文件略微调整则能够间接运行发动 Http 申请。
配置模版
在设置窗口,能够设置模版,只有保留占位字段,其余内容能够任意调整,比方将 ** 接口名称:**
替换为 ### 接口名称:
。
除此之外,也反对其余配置,更多的则须要小伙伴本人摸索啦。
最初
插件是开源在 GitHub,有趣味小伙伴能够看一下,也欢送提交 PR。
GitHub:https://github.com/liuzhihang…
插件文档是放在语雀,不便留言、划词留言等,也欢送独特保护。
阐明文档:https://www.yuque.com/liuzhih…
在阐明文档中有更具体的应用哦!
感激:lvgo、知一、大斌、liaozan、ayang0422 等等小伙伴的参加。
本文由 mdnice 多平台公布