Intellij IDE 插件--DocumentAssistant 自动RESTful API 文档生成

最新推荐文章于 2025-04-24 14:13:53 发布

TONY Yan

最新推荐文章于 2025-04-24 14:13:53 发布

阅读量6.4k

点赞数 7

分类专栏： JAVA intellij 文章标签：文档自动生成 intellij IDE 文档生成插件 0代码侵入生成文档 RESTful API 文档生成基于SpringMVC文档自动生成

本文链接：https://blog.youkuaiyun.com/tony308001970/article/details/88352689

版权

本文介绍了DocumentAssistant，一个IntelliJ IDEA插件，可实现0代码侵入的RESTful API文档自动生成。该插件基于SpringMVC，通过接口方法的JAVADOC、URI、请求参数和返回内容等信息生成文档。目前支持Markdown文档生成，未来计划增加自定义模块、PDF和Word导出功能。Document Assistant已在IntelliJ IDEA插件市场提供下载。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

DocumentAssistant

目前Document Assistant 插件已经上传到 Intellij IDE 官方 Plugin repository 当中，大家可以在Intellij IDE 的 plugin Markerplace 下载

今天先介绍一下我的新开发的一个插件，之前看了很多自动生成文档的各个方案。但是想0侵入性是不可能的，但是今天我希望通过intellij IDE插件的方式，做到了真正的0侵入生成 RESTful api文档自动生成。我不想写文档这个想法越发强烈，所以导致我不得不开始着手开始编写一个插件完成其恶心的工作。通过3天努力我终于实现了第一个DocumentAssistant版本。

首先今天希望通过这个博客，提出一个想法。目前DocumentAssistant已经支持基本MD文档生成，后续会添加自定义模块的方式生成文档，而且希望大家一同维护这个DocumentAssistant插件，让他可以更加强大，从而支持PDF导出和Word文档的导出，或者直接上某一个云文档平台。这是伟大的想法，希望大家都可以参与进来。最近我会进行开始整理工作，将一些框架和插件进行在GitHub开放源代码。

来先看看我写的小东西。

这是一个非常普通的Spring RestController代码

@RestController
@RequestMapping("/depositOrder")
public class Deposi

最低0.47元/天解锁文章