# 🎨特性
- 文档模板: 支持修改文档模板来生成自定义的接口文档。
- 接口文档同步: 支持将接口信息同步至
ApiFox
、ShowDoc
、YApi
等第三方接口文档平台。 - 注解支持: 支持
@Valid
相关注解表示参数是否必填,支持@JsonIgnore
等注解。 - 注释支持: 支持解析Java注释为字段中文描述、接口名称、接口描述等,无需通过类似
Swagger
注解来标识字段名。 - Swagger支持: 支持读取
Swagger
注解信息,如果同时有注释信息和Swagger
注解, 则Swagger
优先级更高。 - 自定义数据支持: 支持读取代码中指定注解信息、支持读取代码注释中指定的标签信息 可直接在接口文档模板中通过
${fudoc.tagName}
方式使用该数据。 - @see注解支持: 支持在字段上标识
@see
注解引用枚举 生成文档时会自动生成该字段的枚举字典信息在备注上 - rpc支持: 支持
Dubbo
Feign
等接口生成接口文档。 - SpringBoot支持: 自动解析Spring环境和配置文件,无需手动配置接口请求端口等信息。
- 接口请求: 通过优美的图形化界面(借鉴
PostMan
)发起接口请求。 - curl命令: 支持一键拷贝curl命令。
- 脚本支持: 支持对指定项目配置前置脚本(
JavaScript
脚本)来实现一些鉴权等操作,支持实时调试脚本。 - 全局参数: 支持配置全局请求头、支持配置全局变量,全局管理Cookie。
- 鉴权信息管理: 支持配置多个鉴权用户,在接口请求界面可手动切换不同鉴权用户发起接口请求
- 环境管理: 默认自动读取SpringBoot环境,支持手动配置环境并在请求面板中手动切换不同环境
- 文件上传下载: 接口请求支持文件的上传和文件下载
- 请求日志: 每次请求时都会在请求面板的
Console
面板输出完整的请求日志,便于排查问题 - url快速搜索: 通过快捷键
CTL+ALT+\
或CMD+ALT+\
快速搜索接口 - 代码补全: 支持通过代码补全方式生成A对象属性赋值到B对象属性的代码(针对不喜欢通过
BeanUtils.copy
的同学非常友好) - 稳定可靠: 历时1年多迭代了近20多个版本。
# ✨版本说明
提示
目前插件仅支持IDEA2020.2 +以上的版本, 建议升级到idea2021以上的版本会有更好的体验和更多的功能支持
222.*
支持IDEA2022.2 + 版本
212.*
支持IDEA2021.2 ~ 2022.2版本
203.*
支持idea2020.2 ~ idea2021.2版本
- name: 222.*
desc: 支持IDEA2022.2 + 版本
bgColor: '#CBEAFA' # 可选,默认var(--bodyBg)。颜色值有#号时请添加单引号
textColor: '#6854A1' # 可选,默认var(--textColor)
- name: 212.*
desc: 支持IDEA2021.2 ~ 2022.2版本
bgColor: '#718971'
textColor: '#fff'
- name: 203.*
desc: 支持idea2020.2 ~ idea2021.2版本
bgColor: '#FCDBA0'
textColor: '#A05F2C'
# 🏡代码托管
# 💪🏻参与开发
欢迎各路好汉一起来参与完善 Fu Doc
,我们期待你的 PR!
如果想贡献,请先查看参与开发。