IDEA必备插件!一键生成接口文档

IDEA是一款功能强大的集成开发环境(IDE),它可以帮助开发人员更加高效地编写、调试和部署软件应用程序。我们在编写完接口代码后需要进行接口调试等操作,一般需要打开额外的调试工具,而今天给大家介绍一款IDEA插件:Apipost-Helper-2.0。代码写完直接编辑器内调试、还支持生成接口文档、接口树等功能,并且完全免费!

这款插件由Apipost团队开发的,其官方介绍是:用于IDEA项目快速生成API文档,快速查询接口、接口代码功能,并支持在IDEA中进行API调试操作。在IDEA编辑器插件中心输入Apipost 搜索安装: Apipost-Helper-2.0

IDEA必备插件!一键生成接口文档_第1张图片

插件配置

使用Apipost IDEA 插件前需要在IDEA设置中进行配置:
云端域名默认为:https://sync-project-ide.apipost.cn 无需修改

请求token可以在Apipost 「项目设置」- 「对外能力」-「openAPI」中创建使用,也支持在IDEA中直接获取请求token。

IDEA必备插件!一键生成接口文档_第2张图片

无侵入生成API文档

编写完代码后,只需右键upload同步接口即可快速将源码中包含的API以及注解自动生成API文档,并生成可以访问的链接。无需任何额外操作。

IDEA必备插件!一键生成接口文档_第3张图片

快速调式(类似Postman)

编写完代码后,点击右侧图标,可以进行快速调试

IDEA必备插件!一键生成接口文档_第4张图片

根据API搜索对应源码、接口树

右侧接口调试栏新增搜索功能可以根据API搜索对应源码、接口树

根据API搜索对应源码:

IDEA必备插件!一键生成接口文档_第5张图片

根据API在接口树中搜索API:

IDEA必备插件!一键生成接口文档_第6张图片

根据源码method跳转到对应API树处

接口代码处展示箭头图标,点击即可快速跳转至对应接口列表处

IDEA必备插件!一键生成接口文档_第7张图片

发送记录查看

点击左下角发送界面按钮,可查看接口的发送记录和发送详情

IDEA必备插件!一键生成接口文档_第8张图片

新增保存、查看保存记录

调试接口时某些接口返回数据需要记录,本次更新新增保存功能,发送请求后点击保存可保存该次的发送详情和返回详情。

IDEA必备插件!一键生成接口文档_第9张图片

可以点击发送记录按钮查看保存的记录

IDEA必备插件!一键生成接口文档_第10张图片

你可能感兴趣的:(intellij-idea,java,ide)