IDEA插件:Restful 接口文档生成工具、助手,支持单个或批量导出接口信息+文档信息到Postman或Markdown

本文介绍了DocerSavior插件,这是一款能够帮助开发者快速生成Controller方法的Restful API文档,并将其导出到Postman的工具。通过解析注解和源码,该插件自动生成包括请求地址、方法、字段说明等详细信息的文档,支持@ApiModelProperty、@ApiOperation等注解,同时允许使用#代替@进行注释,简化了API文档的创建过程。

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

IDEA插件:Restful 文档生成插件,导出接口信息+文档信息到postman

插件名称: Docer Savior

Docer Savior - Plugin Homepage

更多说明:https://www.yuque.com/gudqs7/docer

插件展示

方法名上右键

如上图所示,这是一个常规的 Controller 方法,带 javadoc、统一返回类包装、入参采用 @RequestBody + 普通参数;此时,只需在方法名上右键,然后选择:生成Api文档(restful)即可得到下图文档。

Typora导出 HTML 然后网页插件截图所得

没错,只需这么右键一点,你就得到了这个方法的文档(还是自动复制到剪切板哦),是不是很方便!

使用教程

  • 其实没啥教程
  • 请求地址、请求方法都是从 @ReqeustMaping 注解获取的(@GetMapping@PostMapping也支持),contentType 是根据参数是否带有 @ReqeustBody 注解来判断的
  • 字段说明那个表格:字段、类型就是根据解析源码得到,必填项、含义、其他参考信息则是通过读取注释(或注解)得到
  • 本插件支持注解:@ApiModelProperty@ApiOperation@ApiParam@RequestParam;这几个用于读取必填项、含义、其他参考信息、方法信息
  • 本插件支持注释:
/**
 * 字段含义
 * @required
 * @example xxxx
 * @notes xxxxxxxxxxxxxxxxx
 * @important
 */
  • required 就是是否必填,不写默认是否,写上则代表必填,如果写出 @required false 则也代表非必填
  • @example 就是 json 示例中的值,若不指定,8大基本类型默认为 0、false等值,字符串、日期则采用字段含义
  • @notes 就是其他参考信息
  • @important 代表是否覆盖注解,因为字段上可写注释,也可写注解,若使用了 @ApiModelProperty,加上这个,则忽视注解,仍采用注释

另外照顾到IDEA对于注释中未知的 @xxx 会有丑陋的提示,因此你可以将 @ 替换为 #,照样生效,是不是很赞!

顺带一提,方法上的 @param 注解时,required、example、notes 、important 依然支持,但不需要 @ 前缀,另外使用=连接键值,值不支持包含空格(这是因为解析不够智能的原因…)

评论 13
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值