告别手写,使用 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 等等小伙伴的参与。

目录
相关文章
|
8月前
|
JavaScript Java 测试技术
基于小程序的四六级词汇+springboot+vue.js附带文章和源代码设计说明文档ppt
基于小程序的四六级词汇+springboot+vue.js附带文章和源代码设计说明文档ppt
47 0
|
8月前
|
JavaScript Java 测试技术
基于springboot+vue.js的教师工作量管理系统附带文章和源代码设计说明文档ppt
基于springboot+vue.js的教师工作量管理系统附带文章和源代码设计说明文档ppt
35 1
|
8月前
|
JavaScript Java 测试技术
基于ssm+vue.js的四六级报名与成绩查询系统附带文章和源代码设计说明文档ppt
基于ssm+vue.js的四六级报名与成绩查询系统附带文章和源代码设计说明文档ppt
65 0
|
8月前
|
JavaScript Java 测试技术
基于ssm+vue.js的高等数学试卷自动生成系统附带文章和源代码设计说明文档ppt
基于ssm+vue.js的高等数学试卷自动生成系统附带文章和源代码设计说明文档ppt
51 0
|
8月前
|
JavaScript Java 测试技术
基于springboot+vue.js的网上选课系统附带文章和源代码设计说明文档ppt
基于springboot+vue.js的网上选课系统附带文章和源代码设计说明文档ppt
50 0
|
8月前
|
JavaScript Java 测试技术
基于小程序的商品展示+springboot+vue.js附带文章和源代码设计说明文档ppt
基于小程序的商品展示+springboot+vue.js附带文章和源代码设计说明文档ppt
49 0
|
8月前
|
JavaScript 关系型数据库 Java
MyBatisPlus 最新版代码生成器(直接拿来就能用,包含自动生成 Vue 模版)
MyBatisPlus 最新版代码生成器(直接拿来就能用,包含自动生成 Vue 模版)
981 0
|
8月前
|
小程序
微信小程序手写table表格
微信小程序手写table表格
|
前端开发
前端学习笔记202306学习笔记第三十八天-手写find
前端学习笔记202306学习笔记第三十八天-手写find
57 0
|
前端开发 API 开发者
如何写好API接口文档
如何写好API接口文档