跳到主要内容

IDE插件

IDEA插件简述

Apipost所提供的 Apipost-Helper-2.0 IDEA插件,以其快速扫描代码、基于注解提取信息、支持直接调试及生成API文档等功能而备受青睐,堪称高效提升开发效率、便捷生成接口文档的利器。

image.png

特别说明

支持版本19年3月到23年的IDEA

提示

Apipost 8版本开始,IDEA的云端API需要按照以下修改。

版本云端API地址
Apipost V7https://sync-project-ide.apipost.cn
Apipost V8+(协作版)https://open.apipost.net

⚡️⚡️⚡️配置路径Idea - Settings - Other Settings - Apipost V2 Config - Authentiation。同时,您需要重新获取新的 token

Apipost Helper的使用

01、搜索安装

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

image.png

02、插件配置

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

打开IDEA编辑器,进入Idea - Settings - Other Settings - Apipost V2 Config - Authentiation。根据Apipost的版本填写对应的云端API地址。

版本云端API地址
Apipost V7https://sync-project-ide.apipost.cn
Apipost V8+(协作版)https://open.apipost.net

配置完成后,获取token即可。

新版本增加了新的功能,包括api路径设置、环境上传、参数的设置 image.png

1、api路径设置和环境上传

新增自动创建module名字和类注释目录,创建的环境会和module名字的目录关联。在插件中创建的环境对应客户端中的环境(会自动增加Idea_前缀来表示此环境在插件中上传) image.png 会将module名字和类注释作为目录上传 image.png

2、参数的设置

image.png 可设置参数风格,比如可将参数映射成全大写、下划线等风格(默认代码为阿里规范,参数分割为小驼峰)。 不需要处理的类(例如javax.servlet.http.HttpServletRequest)。参数映射,将参数映射成其他类型的(此功能的目的是将接口类型的参数映射成实现类)

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

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

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

image.png

04、代码写完快速调试

安装 Apipost Helper 后点击右侧角标可打开接口树管理区,可进行接口调试、接口快速定位等操作。 1.0.18及以后版本新增本地调试环境设置(此功能只设置本地调试时的环境配置,上传的环境还是在setting页面设置) image.png

image.png

image.png

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

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

根据API搜索对应源码:

image.png

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

image.png

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

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

image.png

07、其他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 文档。

IDEA书写要求Java规范示例

2.0版本如果方法上有注释则形成接口名称,如果没有注释,接口路径为方法名;

入参备注如果没有,上传apipost客户端后无法生成入参备注

支持swagger3.0

入参是对象,对象的属性要用段落注释或者swagger才能生成备注

1.0.9之前的版本,入参如果是对象要用@RequestBody修饰,如果是非对象要用@RequestParam修饰,MultipartFile不用修饰,1.0.9版本入参如果是对象,没有用@RequestBody修饰则在query中生成入参(不支持list、map),建议对象用@RequestBody修饰

/** 
* 这是类上的注释
* @author apipost at 2023/7/11 13:48
*/
@RestController
@RequestMapping("api")
public class AController {

/**
* 这是方法的注释(Apipost中的接口名称)
* @param param 入参
* @return
*/
@GetMapping("getMethod")//方法路径(必填)
public String getMethod(@RequestParam String param){
return "success";
}

/**
* 文件上传
* @param file
* @return
*/
@PostMapping("upload")
public R<Void> upload(MultipartFile file) {

System.out.println();
return R.ok();
}

}

/**
*用户信息
* @author apipost at 2023/7/3 14:14
*/
@Data
public class User {
/**
* id
*/
@ApiModelProperty(value = "id")
private Long id;
/**
* 角色集合
*/
private List<String> roleList;
/**
* role对象
*/
private Role role;
}

image.png

支持swagger3.0注释的导入

image.png

联系我们

添加客服微信,进入插件内测群,体验最新功能