告别手写,使用 Doc View 快速生成接口文档

简介: Doc View 是一款快捷生成接口文档 IDEA 插件,使用 Doc View 可以将开发人员从繁琐的文档编写中释放出来,极大的节省开发时间。

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/doc-view


插件文档是放在语雀,方便留言、划词留言等,也欢迎共同维护。


说明文档:https://www.yuque.com/liuzhihangs/doc-view


在说明文档中有更详细的使用哦!



感谢:lvgo、知一、大斌、liaozan、ayang0422 等等小伙伴的参与。

目录
相关文章
|
4月前
|
搜索推荐 算法 Java
基于SpringBoot+Vue电影推荐系统设计和实现(源码+LW+调试文档+讲解等)
基于SpringBoot+Vue电影推荐系统设计和实现(源码+LW+调试文档+讲解等)
|
4月前
|
API
10.SPA项目开发之CRUD+表单验证
10.SPA项目开发之CRUD+表单验证
23 0
|
5月前
|
JavaScript Java 测试技术
基于ssm+vue.js的高等数学试卷自动生成系统附带文章和源代码设计说明文档ppt
基于ssm+vue.js的高等数学试卷自动生成系统附带文章和源代码设计说明文档ppt
38 0
|
算法 程序员 API
如何写一个合格的API文档
如何写一个合格的API文档
517 0
如何写一个合格的API文档
|
前端开发 API 开发者
如何写好API接口文档
如何写好API接口文档
|
前端开发 C++
VS Code配置snippets代码片段快速生成html模板,提高前端编写效率
VS Code配置snippets代码片段快速生成html模板,提高前端编写效率
204 0
|
Java API Maven
接口文档:第二章:使用Swagger接口的文档在线自动生成
接口文档:第二章:使用Swagger接口的文档在线自动生成
219 0
接口文档:第二章:使用Swagger接口的文档在线自动生成
|
JSON 前端开发 数据可视化
再见丑陋的 Swagger,这个API神器界面更炫酷,逼格更高,体验更好
代码未动,文档先行 其实大家都知道 API 文档先行的重要性,但是在实践过程中往往会遇到很多困难。 程序员最讨厌的两件事:1. 写文档,2. 别人不写文档。大多数开发人员不愿意写 API 文档的原因是写文档短期收益远低于付出的成本,然而并不是所有人都能够坚持做有长期收益的事情的。 作为一个前后端分离模式开发的团队,我们经常会看到这样的场景:前端开发和后端开发在一起热烈的讨论“你这接口参数怎么又变了?”,“接口怎么又不通了?”,“稍等,我调试下”,“你再试试..."。 那能不能写好 API 文档,大家都按文档来开发?很难,因为写文档、维护文档比较麻烦,而且费时,还会经常出现 API 更新了
|
JSON 前端开发 数据可视化
再见丑陋的 Swagger,这个API神器界面更炫酷,逼格更高,体验更好!
再见丑陋的 Swagger,这个API神器界面更炫酷,逼格更高,体验更好!
再见丑陋的 Swagger,这个API神器界面更炫酷,逼格更高,体验更好!
|
XML JavaScript Java
技术分享 | 接口自动化测试中如何对xml 格式做断言验证?
在服务端自动化测试过程中,发起请求之后还需要对响应值进行验证,验证响应信息符合预期值之后,这一条接口自动化测试用例才算完整的通过。所以这一章节,将会讲解在接口自动化测试中,是如何对服务端返回的 XML 格式响应内容做断言验证。