一文玩转Apipost-Helper

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

安装

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

配置方法:

使用Apipost IDEA 插件前需要在IDEA设置中进行配置: 云端域名默认为: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) > 文档注释第一行

手动选择项目中目录:

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

相关推荐
Mahir086 小时前
Spring 循环依赖深度解密:从问题本质到三级缓存源码级解析
java·后端·spring·缓存·面试·循环依赖·三级缓存
RyFit7 小时前
SpringAI 常见问题及解决方案大全
java·ai
石山代码7 小时前
C++ 内存分区 堆区
java·开发语言·c++
绝知此事8 小时前
【算法突围 01】线性结构与哈希表:后端开发的收纳术
java·数据结构·算法·面试·jdk·散列表
无风听海8 小时前
C# 隐式转换深度解析
java·开发语言·c#
放下华子我只抽RuiKe58 小时前
React 从入门到生产(四):自定义 Hook
前端·javascript·人工智能·深度学习·react.js·自然语言处理·前端框架
一只大袋鼠8 小时前
Git 进阶(二):分支管理、暂存栈、远程仓库与多人协作
java·开发语言·git
XinZong9 小时前
OpenClaw 实现双重心跳(Heartbeat)+ clawreach虾聊项目实现
javascript
德思特9 小时前
从 Dify 配置页理解 RAG 的重要参数
java·人工智能·llm·dify·rag
YOU OU10 小时前
Spring IoC&DI
java·数据库·spring