跳到主要内容

IDEA 插件帮助

IDEA使用文档​

特别说明：​

支持兼容版本21年3月到23年的IDEA

不再更新1.0，2.0的功能比1.0多，建议大家使用2.0

2.0版本和1.0版本兼容存在，如下图
image.png

安装使用​

一、本地安装Apipost的IDEA2.0插件 或者在插件市场下载最新版​

image.png

二、设置项目token​

云端地址修改为：https://sync-project-ide.apipost.cn
获取token的两种方式
1、在Apipost客户端--项目设置--openAPI--右上角新建

image.png

2、如果token输入框没有文字，右侧按钮为获取token，可以通过账号密码获取token

image.png

1.0.5版本新增自定义host，可配置为自定义变量，在apipost客户端配置具体的自定义变量值，如果不配置则读取配置文件中的端口和server.servlet.context-path

image.png

image.png

三、IDEA内调试功能​

点击右侧Apipost图标，调出操作台，修改参数，直接IDEA中调试即可
image.png

1.0.5版本新增接口树显示备注，接口搜索可搜索备注，可跳转代码可跳转到接口树中，可在接口树中进行搜索（鼠标放在图标上，显示快捷键）

1.0.6版本支持点击行数列箭头跳转到接口树相应接口，右击接口树可进行上传

1.0.7版本新增host设置（旧版本为setting页面设置），全局header设置，本地调试完后上传功能 image.png 注：全局header需要失焦后保存才能成功，host不需要 image.png

四、上传接口功能​

选择2.0版本上传，筛选自己所在的团队--项目--目录，右下角或者通知中会提示接口上传成功的数量

可以选择单个接口上传，单个java类上传，单个或多个包上传

1.0.7版本新增自动新建类注释目录模式，默认为手动选择项目中目录模式，旧版本为手动选择项目中目录模式 image.png

自动新建类注释目录​

上传时选择到项目，自动创建目录，创建的目录为类的注释，如果没有注释则为类名，注释优先级为文档注释标记@module > @menu > @Api（swagger） > 文档注释第一行

手动选择项目中目录​

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

注：如果选过了目录，idea会记录上次选的项目和目录，如果上传和上次一样的项目和目录，直接点确定就可以
image.png

image.png

上传后，有通知提示，可直接点击去调试，跳转Apipost操作台调试，也可点击去分享，浏览器直接打开文档分享的链接

image.png

上传后在Apipost客户端右上角刷新，接口即可展示
image.png

五、IDEA书写要求按照java规范​

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

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

支持swagger3.0

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

如果是json要用@RequestBody修饰，如果是非json要用@RequestParam修饰，MultipartFile不用修饰

/** 
* 这是类上的注释 
* @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