Apipost-Helper使用流程

Apipost-Helper是由Apipost推出的IDEA插件,写完接口可以进行快速调试,且支持搜索接口、根据method跳转接口,还支持生成标准的API文档,注意:这些操作都可以在代码编辑器内独立完成,非常好用!这里给大家介绍一下Apipost-Helper的安装和使用

安装

在IDEA编辑器插件中心输入Apipost 搜索安装: Apipost-Helper-2.0

配置方法:

使用Apipost IDEA 插件前需要在IDEA设置中进行配置:

云端域名默认为:https://sync-project-ide.apipost.cn 无需修改请求token可以在Apipost **「项目设置」- 「对外能力」-「openAPI」**中创建使用,也支持在IDEA中直接获取请求token。

代码零入侵,一键生成API文档

编写完代码后,右键点击 「Upload to Apipost」即可快速将源码中包含的API以及注解同步至Apipost中,并生成可以访问的API文档链接。

代码写完快速调试API

代码编写完成后,可以点击右侧Apipost图标进行快速调试,调试功能新增header、host配置

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

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

根据API搜索对应源码:

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

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

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

支持自动识别、创建目录

在设置中可以配置同步API时的上传方式

自动新建类注释目录:

上传时选择到项目,自动创建目录,创建的目录为类的注释,如果没有注释则为类名,注释优先级为文档注释标记@module > @menu > @Api(swagger) > 文档注释第一行

手动选择项目中目录:

上传时可选择到目录下或者项目下,旧版本为此模式,当前默认为此模式

相关推荐
陈平安Java and C41 分钟前
MyBatisPlus
java
秋野酱1 小时前
如何在 Spring Boot 中实现自定义属性
java·数据库·spring boot
Bunny02122 小时前
SpringMVC笔记
java·redis·笔记
feng_blog66882 小时前
【docker-1】快速入门docker
java·docker·eureka
枫叶落雨2224 小时前
04JavaWeb——Maven-SpringBootWeb入门
java·maven
xqlily4 小时前
通过 Visual Studio Code 启动 IPython
ide·vscode·ipython
m0_748232394 小时前
SpringMVC新版本踩坑[已解决]
java
码农小灰4 小时前
Spring MVC中HandlerInterceptor和Filter的区别
java·spring·mvc
乔木剑衣5 小时前
Java集合学习:HashMap的原理
java·学习·哈希算法·集合
齐鲁物联网测试中心王工5 小时前
信创产品测试包括哪些内容?有哪些常用的信创测试工具?
测试工具·信创产品测试·信创产品认证·信创产品·信创认证