为了不写接口文档,我肝了个 IDEA 插件!

简介: 我要写个 IDEA 插件,以后再也不想手写文档了!下面,来看看我肝出来的插件吧!

前言


写代码的快乐,在于通过一顿猛如虎的操作,实现了自己设计的逻辑流程。(也可能并不是很快乐!)

这时候,你以为就可以关机么?

还有接口文档没写呢!

哈?

网络异常,图片无法展示
|

开始进入无限 CV 模式,各种请求参数、必填非必填、请求返回示例!

几分钟后…… 🤬🤬🤬

网络异常,图片无法展示
|

我要写个 IDEA 插件,以后再也不想手写文档了!

下面,来看看我肝出来的插件吧!


功能介绍

插件名字必须得先介绍,Doc View,有兴趣的小伙伴直接在 IDEA 中搜索插件即可。

  • Controller/Dubbo 接口文档生成
  • 支持 Validation、Swagger 等注解
  • Markdown 接口查看、预览、复制、导出
  • 支持自定义生成接口的 Markdown 模版
  • 支持界面编辑文档、注释、并同步保存到代码注释中
  • 支持在编辑实体界面, 将实体复制为 Json 字符串
  • 支持上传文档到 YApi
  • 支持自定义配置

功能就不留悬疑了,直接介绍出来,下面用再用图文介绍下,毕竟干巴巴的说文字介绍,也太么得感情了!


主界面

网络异常,图片无法展示
|


生成 Markdown

生成 Markdown 文档包含:接口名称、接口描述、请求路径、请求方式、请求参数、请求示例、返回参数、返回示例。

这些全都是根据方法的注释、注解、出参、入参解析出来的

小伙伴想看源码或者提交 PR,文末有 github 地址。

为什么生成 Markdown?

因为格式比较好看,并且很容易转换为 Html、PDF、Word 等格式。

直接将 Markdown 文本复制到 VS Code,预览图如下:

网络异常,图片无法展示
|

  • 自定义 Markdown

这里也是支持一定程度上自定义 Markdown 的格式的。

网络异常,图片无法展示
|

可以在 IDEA 设置选项中,找到 Doc View 的相关设置,进行自定义 Markdown 的样式。

  • 字段注释设置

这里支持 Swagger3、Swagger、注释 tag 的方式设置相关信息。

网络异常,图片无法展示
|


面板功能

  • 预览

网络异常,图片无法展示
|

左下角直接使用 IDEA 内置 Markdown 面板进行预览文件。

IDEA 2020.2 以上版本才可以哦!

  • 导出

在面板左右两边,分别有两个导出按钮,对应着批量导出和导出当前。

  • 复制

直接将 Markdown 文本复制到剪贴板。不过也可以直接在文本域中使用 ⌘ + A 全选后复制。

也可以 ⌘ + F 唤出搜索框,不过一般很少使用。


上传 YApi

如果说生成 Markdown 文本,是为了方便复制到 ShowDoc 之类支持 Markdown 的 API 文档网站,那 Api 呢?

这里也是支持的!

直接通过上传按钮,可以一键上传到 YApi。

网络异常,图片无法展示
|

不过记得设置地址和 Token。


文档编辑

核心功能除了生成 Markdown、预览、上传 YApi 之外,这个功能相对来说还不是很完善。

那就是编辑文档及字段。

网络异常,图片无法展示
|


Doc Editor 可以在方法、实体类中使用,并生成相应的注释。

网络异常,图片无法展示
|

并且可以将实体类复制为 Json。

这个功能和 Toolkit 类似。


总结


整体功能就这些了,基本可以满足大部分文档需求。其他的就是边边角的修修改改。

来来来,小伙伴们一起用起来,帮忙踩踩坑,提提建议。

目录
相关文章
|
2月前
|
网络协议 Windows
两步带你解决IDEA 插件下载安装慢、超时、不成功问题
这篇文章提供了解决IDEA插件下载慢或超时问题的方案,通过查找国内插件节点IP地址并修改本地hosts文件来加速下载。
两步带你解决IDEA 插件下载安装慢、超时、不成功问题
|
8天前
|
Java
轻松上手Java字节码编辑:IDEA插件VisualClassBytes全方位解析
本插件VisualClassBytes可修改class字节码,包括class信息、字段信息、内部类,常量池和方法等。
57 6
|
2月前
|
Java
可直接编辑jar包的IDEA插件-JarEditor
IDEA自带的反编译插件虽可查看jar包中的class文件,但无法直接编辑。为解决此问题,作者开发了JarEditor插件,可在IDEA中直接编辑jar文件内的class及资源文件,无需解压或手动编译。点击Jar Editor可修改代码,通过Save/Compile保存并编译,Build Jar则将更改写回jar包。该插件简化了jar包编辑流程,提高了开发效率。
187 4
可直接编辑jar包的IDEA插件-JarEditor
|
4月前
|
IDE 程序员 开发工具
IDEA插件-IKun Progress 坤坤成IDEA进度条了
"IKun Progress"是一款适用于JetBrains IntelliJ IDEA等IDE的插件,该插件能够将标准的进度条替换为一个有趣且独特的篮球动画,其中的角色名为坤坤(Kun Kun)。它旨在为您的IDE使用过程增添一些娱乐和轻松的氛围。 该插件让您可以在执行IDE中的任务时享受到更加视觉上吸引人的进度指示器,例如构建、运行测试或其他涉及进度条的操作。相比传统的普通进度条,您将看到坤坤在打篮球,给您的开发工作流程增添了一份乐趣。
694 0
IDEA插件-IKun Progress 坤坤成IDEA进度条了
|
4月前
|
IDE 程序员 开发工具
IDEA插件-Mario Progress Bar马里奥进度条
"Mario Progress Bar"是一款适用于JetBrains IntelliJ IDEA等IDE的插件,它基于Dmitry Batkovitch开发的Nyan Progress Bar。该插件会将进度条样式变成马里奥游戏中的角色。基本的进度条显示为带有一些砖块的马里奥形象,而不确定状态的进度条显示为一个乌龟壳。一旦安装完成,您可以在IDE的设置中找到插件的配置选项(Settings > Tools > Mario Progress Bar),在此处选择您喜欢的角色形象。
257 0
IDEA插件-Mario Progress Bar马里奥进度条
|
1月前
|
Windows
IDEA如何查看已经安装的插件并删除
【10月更文挑战第1天】这段内容主要介绍了如何在IntelliJ IDEA中查看和删除已安装的插件。可以通过软件内的插件市场查看插件列表,包括插件名称、版本号和供应商等信息;也可以通过访问插件目录查看。删除插件则建议在插件市场中进行,包括禁用和卸载步骤,手动删除插件文件夹的方法不推荐,因为可能存在配置残留等问题。
501 11
|
1月前
|
人工智能 Java 数据库连接
IDEA开发 常用代码规范插件 常用辅助类插件
IDEA开发 常用代码规范插件 常用辅助类插件
45 0
|
1月前
|
IDE Java Maven
分享几个实用的IDEA插件,提高你的工作效率!
分享几个实用的IDEA插件,提高你的工作效率!
136 0
|
3月前
|
自然语言处理 JavaScript 算法
【插件】IDEA这款插件,爱到无法自拔
本文介绍了阿里云「通义灵码」这一强大IDEA插件,它不仅能够智能生成代码、解答研发问题,还支持多种编程语言和编辑器。文章详细展示了如何安装使用该插件,并通过多个实际案例说明其在代码解释、优化、生成注释及单元测试等方面的应用,助力开发者提高效率。强烈推荐尝试!
120 1
【插件】IDEA这款插件,爱到无法自拔
|
3月前
|
Java
2022年最新最详细的IntelliJ idea高效插件的介绍安装,让你的工作效率提升10倍
这篇文章详细介绍了10款IntelliJ IDEA的高效插件,包括Codota代码智能提示、Key Promoter X快捷键提示、CodeGlance代码缩略图、Lombok代码简化、阿里巴巴代码规范检查、SonarLint代码质量检查、Save Actions格式化代码、Translation翻译、Rainbow Brackets彩虹括号和Nyan Progress Bar彩虹进度条插件,旨在帮助提升开发效率和代码质量。
2022年最新最详细的IntelliJ idea高效插件的介绍安装,让你的工作效率提升10倍