Apipost IDEA插件介绍

Apipost Helper，作为IDEA插件，可以快速生成和查询API文档，直观友好地在IDE中调试接口。它简化了开发流程并提升效率，即使新手也能够迅速掌握。Apipost Helper提供了诸多便捷功能，如通过代码查找接口或者通过接口查找代码等，可以帮助开发人员高效地调试API并一键生成文档。

Apipost Helper=Restfultool+Yapi+Swaggertool+Showdoc

IDEA插件一键上传到Apipost效果图

Apipost Helper的使用

1、搜索安装

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

2、插件配置

我们在使用Apipost IDEA 前需要在IDEA设置中进行简单的配置，包括设置云端域名和获取请求token，这些步骤并不复杂，且一次配置后，即可长期享受其带来的便利。

云端域名默认为：

https://sync-project-ide.apipost.cn 无需修改

请求token可以在Apipost 「项目设置」- 「对外能力」-「openAPI」中创建使用，也支持在IDEA中直接获取请求token。

配置完成后，插件将无缝集成到IDEA中，成为日常开发工作的一部分。

3、代码写完快速上传至Apipost

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

4、代码写完快速调试

安装 Apipost Helper 后点击右侧角标可打开接口树管理区，可进行接口调试、接口快速定位等操作。

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

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

根据API搜索对应源码：

根据API在接口树中搜索API：

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

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

 

Apipost Helper 特色功能

• 支持Api IDEA本地调试；

• 接口树形展示；

• 接口搜索，可搜索注释；快捷键mac：command+\ win:Ctrl+\

• 接口树搜索，可搜索注释；快捷键mac：option+\ win:Alt+\

• 代码与接口树互相跳转；

• 本地调试接口发送历史记录功能；

• 本地调试接口保存入参出参和保存记录查询；

• 本地调试可配置Host、全局Header；

• 本地调试完后上传Api功能；

• 上传可配置前缀Host；

• 支持多种上传Api方式；

• 支持 Swagger2.0和Swagger3.0注解；

• 自定义参数解析；

• 基于 Javadoc（Java）、KDoc（Kotlin）、ScalaDoc（Scala） 解析 API 文档。

写 在 最 后

Apipost Helper是针对大家在开发过程中关于接口定位、接口文档、调试等痛点功能推出的IDEA插件，可在IDEA内进行一键调试、一键生成接口文档、一键定位接口位置等操作，操作简单，且完全免费！建议还没有使用过的同学安装试试～

Apipost Helper还在不断收集用户的优化建议，希望更多的用户能够参与进来，也希望越来越多的朋友能够了解、使用到这款插件，从中受益。如果您对Apipost IDEA 插件的功能有任何建议或者在使用过程中遇到了问题，可以扫描下方二维码和我们取得联系。