一文玩转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) > 文档注释第一行

手动选择项目中目录:

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

相关推荐
To_OC4 小时前
写了三遍 Todo List,我终于搞懂了 React 父子组件到底怎么通信
前端·javascript·react.js
勇往直前plus4 小时前
Vue3(篇一) 核心概念——响应式模板语法与组件基础
前端·javascript·vue.js
用户938515635076 小时前
从零搭建 AI 日记助手:用 Milvus 向量数据库 + RAG 让机器读懂你的每一天
javascript·人工智能·全栈
小Ti客栈6 小时前
Spring Boot 集成 Springdoc-OpenAPI 与 Knife4j实现接口文档与可视化调试
java·spring boot·后端
Ai拆代码的曹操7 小时前
Spring 事务 REQUIRES_NEW 嵌套调用:连接池翻倍的秘密
java·后端·spring
a1117767 小时前
坦克大战3D Three.js 3D (开源项目)
开发语言·javascript·3d
动恰客流统计7 小时前
ReID边缘计算视觉统计:餐饮店客流增长的数字化破局路径
java·大数据·运维·人工智能
kyriewen8 小时前
别再乱用useEffect了——你写的10个里有8个不该存在
前端·javascript·react.js
Ivanqhz8 小时前
Rust &‘static str浅析
java·前端·javascript·rust
IT_陈寒8 小时前
SpringBoot这个分页坑,我踩了三天才爬出来
前端·人工智能·后端