特别说明:2.1版本和1.0版本兼容存在,如下图
安装使用
一、本地安装Apipost的IDEA2.1插件,支持兼容版本20年3月到23年的IDEA
二、设置项目token
云端地址修改为:https://sync-project-ide.apipost.cn
在Apipost客户端--项目设置--openAPI--右上角新建
三、IDEA中右侧打开调试操作台
点击右侧Apipost图标,调出操作台,修改参数,直接IDEA中调试即可
四、上传接口
选择2.1版本上传,筛选自己所在的团队--项目--目录,右下角或者通知中会提示接口上传成功几个 注:如果选过了目录,idea会记录上次选的项目和目录,如果上传和上次一样的项目和目录,直接点确定就可以
上传后在Apipost客户端右上角刷新,接口即可展示
五、IDEA书写格式
目前Apipost的IDEA插件内书写格式:
- 要有类上注释
- 要有类
- 要有方法注释
如果类上有注释则形成接口名称,如果没有注释,接口路径为方法名
caution
Api的总路径和方法路径也记得写
/**
* 这是类上的注释(必填)
* @author 睿睿 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";
}
}
具体实战操作如下图:
也支持swagger注释的导入,如下图: