Apipost-Helper-2.0 IDEA插件,因快速扫描代码、基于注解提取信息、支持直接调试及生成API文档等功能受到众多用户的认可,是目前市面上一款真正高效便捷生成接口文档的利器。本月初,Apipost IDEA插件又迎来重大优化,在应用市场搜索Apipost-helper,下载或者更新至最新版本1.0.19即可。
相对来说,新版Apipost IDEA的配置选项更丰富,接下来我们就看看这次更新版本的具体变化:
一、UI界面优化,配置选项更灵活
新版Apipost IDEA的UI设计配置选项更加丰富灵活。过去版本只有一个设置页,新版则将当前用户信息和上传设置细分为了两个独立页面,界面更加清晰,操作更加便捷。这样我们能够更快速地找到并设置自己需要的选项,大大提高工作效率。
二、上传方式全面自定义
(一)支持环境上传
新版Apipost IDEA插件,引入了强大的环境上传功能,彻底解决了以往在单一环境中上传API文档或测试数据的局限性。我们可以根据项目的不同开发阶段(如开发环境、测试环境、生产环境)或不同的服务器配置,轻松创建并管理多个上传环境。每个环境都可以独立配置API的URL、请求头、认证信息等,确保API文档和测试数据能够准确无误地对应到目标环境中。无论是进行日常的API测试,还是准备将应用部署到生产环境,您都可以一键切换至相应的环境配置,无需手动修改任何代码或配置文件,即可快速完成上传任务。
👆上传路径设置及环境设置
(二)参数命名规则可自定义:
在新版IDEA插件中,我们可以根据项目需求或个人偏好,自由设置上传参数的命名规则,让API文档的呈现更加符合期望。
-
灵活控制父类属性:
新版插件支持自定义是否包含父类属性在上传内容中,对于处理复杂继承关系的项目来说,该功能非常重要。
-
序列化选项更灵活:
为适应不同的API接收需求,我们可以选择是否对上传参数进行序列化。
-
参数映射更强大
新增的参数映射功能,能够更精确地控制请求体中的参数与代码中变量的对应关系,减少错误,提升准确性。
三、本地调试体验升级
支持环境的创建和维护
新版本的IDEA还重点优化了本地调试功能,支持创建和维护多个调试环境,每个环境都可以自定义请求头等信息。
本地调试环境设置
四、IDE插件更多使用说明
1、代码写完快速上传至Apipost
编写完代码后,右键点击「Upload to Apipost」即可快速将源码中包含的API以及注解同步至Apipost中,并生成可以访问的API文档链接。
2、代码写完快速调试
安装 Apipost Helper 后点击右侧角标,打开接口树管理区,可进行接口调试、接口快速定位等操作。
3、根据API搜索对应源码、接口树
右侧接口调试栏新增搜索功能可以根据API搜索对应源码、接口树。
根据API搜索对应源码:
根据API在接口树中搜索API:
4、根据源码method跳转到对应API处
接口代码处展示箭头图标,点击即可快速跳转至对应接口列表处