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

目录
相关文章
|
人工智能 自然语言处理 搜索推荐
Perplexity AI和秘塔AI相比如何?
【2月更文挑战第16天】Perplexity AI和秘塔AI相比如何?
1594 1
Perplexity AI和秘塔AI相比如何?
|
XML 人工智能 JSON
autojs之vscode必装插件
Color Highlight Highlight web colors in your editor
2120 0
autojs之vscode必装插件
|
Kubernetes 应用服务中间件 Docker
在K8S中,Pod网络访问与Docker容器端口映射有何不同?
在K8S中,Pod网络访问与Docker容器端口映射有何不同?
|
11月前
|
机器学习/深度学习 人工智能 数据可视化
【AI大模型】深入Transformer架构:编码器部分的实现与解析(上)
【AI大模型】深入Transformer架构:编码器部分的实现与解析(上)
|
Linux 编译器 C语言
Linux内核对GCC版本的检测
Linux内核对GCC版本的检测
|
11月前
|
Java API Maven
使用 Smart-doc 记录 Spring REST API
使用 Smart-doc 记录 Spring REST API
256 0
基因组组装:Hifiasm 使用教程
基因组组装:Hifiasm 使用教程
|
SQL 算法 关系型数据库
MySQL参数优化之join_buffer_size
MySQL参数优化之join_buffer_size
710 0
MySQL参数优化之join_buffer_size
聊聊自动化测试的度量指标
在聊自动化测试度量指标前,有必要回到做自动化的初衷上,就是为什么要做自动化测试,要解决什么问题。
【stream】List根据某个字段求和
【stream】List根据某个字段求和
780 0