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

手动选择项目中目录:

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

相关推荐
努力也学不会java10 分钟前
【设计模式】 原型模式
java·设计模式·原型模式
方渐鸿32 分钟前
【2024】k8s集群 图文详细 部署安装使用(两万字)
java·运维·容器·kubernetes·k8s·运维开发·持续部署
学亮编程手记36 分钟前
K8S v1.33 版本主要新特性介绍
java·容器·kubernetes
Haven-2 小时前
Java-面试八股文-JVM篇
java·jvm·面试
我真的是大笨蛋2 小时前
JVM调优总结
java·jvm·数据库·redis·缓存·性能优化·系统架构
wjs0402 小时前
Git常用的命令
java·git·gitlab
superlls2 小时前
(算法 哈希表)【LeetCode 349】两个数组的交集 思路笔记自留
java·数据结构·算法
田里的水稻3 小时前
C++_队列编码实例,从末端添加对象,同时把头部的对象剔除掉,中的队列长度为设置长度NUM_OBJ
java·c++·算法
ponnylv3 小时前
深入剖析Spring Boot启动流程
java·开发语言·spring boot·spring
前行的小黑炭3 小时前
Android 协程的使用:结合一个环境噪音检查功能的例子来玩玩
android·java·kotlin