IDEA插件:Restful 文档生成插件,导出接口信息+文档信息到postman
插件名称: Docer Savior
Docer Savior - Plugin Homepage
更多说明:https://www.yuque.com/gudqs7/docer
插件展示
如上图所示,这是一个常规的 Controller 方法,带 javadoc、统一返回类包装、入参采用 @RequestBody + 普通参数;此时,只需在方法名上右键,然后选择:生成Api文档(restful)即可得到下图文档。
没错,只需这么右键一点,你就得到了这个方法的文档(还是自动复制到剪切板哦),是不是很方便!
使用教程
- 其实没啥教程
- 请求地址、请求方法都是从
@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 依然支持,但不需要 @ 前缀,另外使用
=
连接键值,值不支持包含空格(这是因为解析不够智能的原因…)