告别手写,使用 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相比如何?
2420 1
Perplexity AI和秘塔AI相比如何?
|
XML 人工智能 JSON
autojs之vscode必装插件
Color Highlight Highlight web colors in your editor
2453 0
autojs之vscode必装插件
执行apt-get install xxx 遇到无法定位软件包解决方法
执行apt-get install xxx 遇到无法定位软件包解决方法
6000 0
执行apt-get install xxx 遇到无法定位软件包解决方法
|
7月前
|
存储 缓存 Java
Python中的__slots__:减少内存占用的高级技巧
本文深入解析Python的`__slots__`机制,从内存开销原理、优化机制、实践技巧、继承处理到典型场景(如金融系统、游戏实体、缓存),全面阐述其减少30%–50%内存占用、提升20%–50%属性访问速度的核心价值,并提醒使用限制与最佳实践。(239字)
357 0
|
6月前
|
机器学习/深度学习 人工智能 编解码
AI视频去字幕技术完全指南:原理、方法与工具对比(2026版)
本文深度解析AI视频去字幕技术,涵盖原理(OCR检测+GAN修复+时序一致性)、主流工具横评、分步实操教程及短视频、教育、影视等六大行业应用。适合创作者、自媒体人与技术爱好者,20分钟掌握高效去字幕方法。
2314 1
|
人工智能 安全 大数据
开启矿山新时代:数字孪生矿山系统引领未来
数字孪生矿山利用大数据、AI、实景三维等技术,构建矿山的虚拟映像,实现矿山规划、建设和管理的智能化转型。通过高效集成多源数据,精准复刻矿山全貌,提供实时监控、智能预测和优化决策,提升矿山安全性和经济效益,推动绿色矿业发展。该系统打破信息壁垒,促进协同创新,助力矿山行业迈向智能、绿色、可持续的未来。
|
人工智能 运维 自然语言处理
2025保姆级JupyterLab 4.0安装指南|全平台部署+AI编程环境配置
JupyterLab 是下一代交互式计算开发环境,2025年发布的4.0版本新增多语言内核支持(Python/R/Julia/JavaScript一键切换)、实时协作功能、AI辅助编程(集成GPT-5代码补全与错误诊断)和可视化调试器等特性。本文详细介绍其技术定位、跨平台安装方案、安装流程、高阶功能配置、典型应用场景及故障排查指南,帮助用户高效使用JupyterLab进行开发。
|
人工智能 运维 自然语言处理
对话蚂蚁李建国:当前AI写代码相当于L2.5,实现L3后替代50%人类编程
超70%代码问题,单纯靠基座大模型是解决不了的;未来3-5年,人类50%编程工作可以被替代,有些环节甚至完全自动化。蚂蚁集团代码大模型CodeFuse负责人李建国说道。当下,AI代码生成领域正在野蛮式生长,巨头涌入,AI员工频频上线企业;首个AI程序员Devin被曝造假…… 面对风起云涌的代码生成变革,李建国给出了这样一个明确论断。
531 1
|
机器学习/深度学习 TensorFlow 算法框架/工具
深度学习在图像识别中的应用:一个实战案例
【8月更文挑战第1天】 本文将通过一个实际案例,深入探讨深度学习在图像识别领域的应用。我们将介绍如何利用卷积神经网络(CNN)进行图像分类,并展示一个简单的代码示例。通过本文,您将了解到深度学习技术在解决实际问题中的潜力和挑战。
|
机器学习/深度学习 人工智能 弹性计算
阿里云AI服务器价格表_GPU服务器租赁费用_AI人工智能高性能计算推理
阿里云AI服务器提供多种配置选项,包括CPU+GPU、CPU+FPGA等组合,支持高性能计算需求。本文汇总了阿里云GPU服务器的价格信息,涵盖NVIDIA A10、V100、T4、P4、P100等多款GPU卡,适用于人工智能、机器学习和深度学习等场景。详细价格表和实例规格见文内图表。
3104 0